SuperMartijn642's Config Lib: конфиги без рутины для моддеров [библ]

SuperMartijn642's Config Lib: конфиги без рутины для моддеров

Когда вы погружаетесь в мир модифицированного Minecraft, рано или поздно сталкиваетесь с десятками конфигурационных файлов. За каждым ползунком урона, шансом дропа или радиусом действия стоит рутинная работа разработчика: нужно не только сохранить значение, но и обеспечить его перезагрузку при смене мира, синхронизировать клиент с сервером и не заставлять игрока перезапускать игру без крайней необходимости. SuperMartijn642's Config Lib: конфиги без рутины для моддеров — это как раз тот инструмент, который снимает с моддера всю эту головную боль, оставляя ему лишь творческую часть.

Что это за мод и для кого он

SuperMartijn642's Config Lib: конфиги без рутины для моддеров — не контентный мод в привычном понимании. Вы не найдёте здесь новых блоков, биомов или механик. Это библиотека, которую подключают как зависимость другие проекты. Её задача — предоставить единый, предсказуемый слой для работы с настройками. Если вы разработчик, то вместо ручного парсинга JSON или TOML и написания костылей для синхронизации вы описываете параметры через удобный билдер, а всё остальное библиотека берёт на себя. Игроки же получают аккуратные конфиги с комментариями и автоматической подгрузкой изменений без лишних перезапусков.

Ключевые возможности

• Автоматическая перезагрузка конфигов — значения обновляются при загрузке мира, не требуя рестарта клиента (если это не запрещено явно).
• Синхронизация клиент-сервер — для общих и серверных настроек библиотека сама рассылает актуальные параметры подключившимся игрокам, исключая рассинхрон.
• Валидация ввода — можно задать минимум и максимум для чисел, чтобы случайная опечатка не сломала баланс.
• Комментарии и категории — конфиг-файлы генерируются с понятными подсказками и логической группировкой, что упрощает жизнь и админам серверов.
• Гибкая архитектура — через Supplier вы получаете всегда актуальное значение, а не застывшую копию, которая устаревает после смены мира.

Как работает ModConfigBuilder

Сердце библиотеки — класс ModConfigBuilder. С него начинается описание любого конфига. Вы создаёте экземпляр билдера, а затем поочерёдно добавляете поля методом define, передавая имя параметра и значение по умолчанию. Для целочисленных и дробных величин рекомендуется сразу указывать допустимый диапазон через min и max — так вы страхуетесь от некорректных правок со стороны пользователя.

Важный нюанс: define возвращает не само значение, а Supplier. Именно этот объект нужно сохранить в коде мода и использовать для чтения параметра в любой момент. Благодаря такому подходу вы всегда получаете свежие данные, даже если конфиг был перезагружен между мирами или обновлён сервером.

Управление перезагрузкой и синхронизацией

По умолчанию все параметры перечитываются при каждой загрузке мира. Это удобно для большинства настроек, но иногда изменение «на лету» может вызвать проблемы — например, если параметр влияет на регистрацию блоков или сложную инициализацию. Для таких случаев перед вызовом define используется метод gameRestart(). Он помечает поле как требующее полного перезапуска игры, и библиотека не будет пытаться обновить его динамически.

Синхронизация с клиентами включена для конфигов уровня COMMON и SERVER. Сервер автоматически передаёт актуальные настройки всем подключившимся игрокам, поэтому локальные файлы не конфликтуют с логикой мира. Если же параметр должен оставаться строго локальным (например, настройки отображения), перед define вызывают dontSync() — и поле исключается из сетевого обмена.

Категории и комментарии: порядок в конфигах

Когда параметров становится больше десятка, плоский список превращается в кашу. SuperMartijn642's Config Lib: конфиги без рутины для моддеров решает эту проблему методами push(String) и pop(). Вы «заходите» в категорию, описываете вложенные поля и «выходите» обратно. Для целой секции можно задать пояснение через categoryComment — в итоговом файле появятся заголовки вроде «Клиент», «Генерация» или «Баланс», что невероятно ценится администраторами сборок.

Не забывайте и про обычные комментарии: вызов comment

Автор: KlamrFox

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