Этот мод представляет собой API для интеграции меню настроек Sodium и Embeddium с улучшенным меню категорий.
Мод добавляет кросс-платформенные события, позволяющие создавать страницы опций в меню Sodium/Embeddium. Например, с помощью одного события можно добавить страницу опций для:
- Embeddium на Forge;
- Fabric Sodium 0.5 для версии 1.20.1;
- Fabric/NeoForge Sodium 0.6 для версии 1.21.1.
Пример регистрации страницы опций:
OptionGUIConstruction.EVENT.register((pages) -> pages.add(new TestOptionPage()));
Для конечных пользователей, если этот мод не установлен как библиотека вместе с другим аддоном для Sodium, его можно установить совместно с Reese’s Options для улучшенного меню категорий с поддержкой раскрывающихся списков, что облегчает навигацию. Это работает даже для модов, которые не используют данный API и напрямую внедряются в меню опций Sodium.
Мод частично является форком Embeddium categories API с серьёзными изменениями для поддержки актуальной версии Sodium. Изменения в меню Sodium Options Reese’s вносятся через mixin для обеспечения совместимости, поэтому требуется установка обоих модов.
Установка и использование
Для разработки необходимо добавить мод в среду разработки через Maven релиз:
modImplementation("maven.modrinth:sodium-options-api:version")
В API доступны три события в пакете toni.sodiumoptionsapi.api:
OptionGUIConstruction.EVENT— вызывается один раз при создании GUI, позволяет добавлять целые страницы опций;OptionPageConstruction.EVENT— вызывается для каждой страницы опций, подходит для добавления групп переключателей на вкладки, например, производительности;OptionGroupConstruction.EVENT— вызывается для каждой группы опций, позволяет вставлять отдельные параметры в существующие группы или изменять стандартные.
