Simple Config Lib

Simple Config Lib

Simple Config Lib — это библиотека для модов Minecraft, предназначенная для работы с настройками. Она позволяет разработчику описать конфигурацию обычным Java-классом, после чего библиотека автоматически строит экран настроек в игре и берёт на себя сохранение и загрузку данных.

Главная цель проекта — избавить разработчиков от рутинной реализации системы настроек и обеспечить единый предсказуемый результат на всех поддерживаемых платформах.

Библиотека поддерживает загрузчики Fabric, Forge и NeoForge.

Подробная документация доступна в вики: Simple Config Lib Wiki

Назначение

Библиотека предоставляет единый способ работы с настройками модов, охватывающий описание конфигурации, хранение и отображение.

Simple Config Lib предлагает единственный подход к решению этой задачи:

• конфигурация описывается один раз в виде класса;
• экран настроек генерируется автоматически;
• данные сохраняются и загружаются без дополнительного кода;
• поведение остаётся одинаковым на Fabric, Forge и NeoForge.

Такой подход позволяет разработчикам сосредоточиться на функциональности мода, а не на инфраструктуре его настроек.

Для кого

• Разработчики модов — библиотека предназначена для тех, кто хочет дать пользователям удобный экран настроек, не тратя время на реализацию интерфейса и работу с файлами самостоятельно.
• Игроки — библиотека является зависимостью и обычно устанавливается потому, что её требует другой мод. Отдельная настройка ей не нужна, она просто обеспечивает корректную работу настроек других модов.

Возможности

• Конфигурация описывается на уровне класса с автоматической генерацией экрана настроек.
• Готовый экран настроек, который можно получить одним вызовом сразу после описания конфигурации — построение интерфейса библиотека берёт на себя.
• Автоматическое сохранение и загрузка значений без ручной работы с файлами.
• Одинаковое поведение на всех поддерживаемых загрузчиках.
• Автоматическая локализация на основе структуры конфигурации.
• Богатый набор элементов интерфейса для представления различных типов данных.
• Набор клиентских вспомогательных утилит, упрощающих создание экранов. Как и сама конфигурация, эти утилиты можно использовать независимо от версии игры.
• Серверные конфигурации, синхронизируемые по сети: конфиг, помеченный как серверный, хранится на сервере, отправляется каждому игроку при входе и показывается клиентам только для чтения, если у них нет прав оператора.
• Сетевой слой, независимый от загрузчика и версии: опишите пакет как обычный Java-record и зарегистрируйте его один раз — библиотека построит кодек, зарегистрирует его на каждом загрузчике и обеспечит отправку в обе стороны.

Установка

На загрузчике Fabric для работы библиотеки дополнительно требуется Fabric API. На Forge и NeoForge никаких дополнительных зависимостей не нужно.

FAQ

Нужно ли игрокам устанавливать библиотеку? Только если её требует другой мод. Simple Config Lib — это зависимость, отдельная настройка ей не нужна — она просто обеспечивает работу настроек модов, которые её используют.

Можно ли добавлять библиотеку в модпаки? Да. Библиотеку можно включать в модпаки при условии, что указана ссылка на её оригинальную страницу.

Конфликтует ли библиотека с другими модами? Нет. Simple Config Lib не мешает другим модам и не конфликтует с ними.

Нужно ли писать разный код для разных версий и загрузчиков? Нет. И конфигурация, и вспомогательные утилиты рассчитаны на использование независимо от версии игры и загрузчика — один и тот же код работает везде.

Куда сообщать о багах и предложениях? О багах и предложениях можно сообщать на GitHub.

Статус проекта

Simple Config Lib изначально создавалась для моих собственных проектов. Мне пришлось за неё взяться, потому что многие существующие библиотеки перестали поддерживать Forge на новейших версиях Minecraft.

Проект открытый и продолжает развиваться: набор возможностей будет расширяться, а найденные баги — исправляться.