Общая основа конфигураций
SuperMartijn642's Config Lib предоставляет разработчикам единый способ определять настройки модов. Библиотека берёт на себя повторяющуюся работу с файлами, проверкой значений, загрузкой и синхронизацией, чтобы зависимые проекты могли сосредоточиться на собственной логике.
Для обычного игрока это техническая зависимость. Она не создаёт отдельную систему приключений или набор предметов, но без подходящей версии мод, использующий её API, может не запуститься.
Как устроены параметры
- ModConfigBuilder формирует категории, комментарии и отдельные значения.
- Типизированные настройки помогают ограничивать допустимые данные и избегать некорректной конфигурации.
- Supplier-объекты дают зависимому коду доступ к актуальным значениям.
- Автоматическая синхронизация поддерживает согласованное состояние там, где это требуется.
- gameRestart позволяет отложить применение чувствительного параметра до следующего запуска игры.
После определения значений разработчик завершает конфигурацию вызовом build. Дальнейшая загрузка и обновление выполняются библиотекой согласно выбранным правилам.
Для игроков и авторов сборок
Если загрузчик сообщает об отсутствующей зависимости, нужно установить именно SuperMartijn642's Config Lib для своей версии Minecraft. Похожее название или другой конфигурационный API не заменяют требуемый файл.
При обновлении сборки полезно менять библиотеку вместе с зависимыми модами. Смешивание выпусков для разных загрузчиков или поколений игры обычно приводит к ошибке ещё на стадии запуска.
Сравнение с Cloth Config API
Cloth Config API (Fabric/Forge/NeoForge) известен как API для экранов настроек. Он помогает проектам показывать удобный графический интерфейс конфигурации.
SuperMartijn642's Config Lib сосредоточен на определении, загрузке и синхронизации самих значений. Обе библиотеки могут относиться к конфигурации, но их назначение и интерфейсы различаются, поэтому они не взаимозаменяемы.
Загрузчики и совместимость
Проект выпускается для Forge, NeoForge, Fabric и Quilt и может использоваться на клиенте и сервере. Широкий охват не означает, что один jar подходит везде: для каждой связки версии и загрузчика предназначен свой файл.
SuperMartijn642's Config Lib следует оставлять в сборке, пока хотя бы один установленный мод объявляет её обязательной. Удалять библиотеку как неиспользуемый контент можно только после проверки списка зависимостей.