Forge Config API Port — Minecraft Java Edition

Ванильный Minecraft не содержит встроенных инструментов для удобной настройки параметров игры или модификаций, что вынуждает разработчиков самостоятельно создавать системы сохранения конфигураций. Мод-лоадер Forge предлагает готовое решение в виде собственной системы конфигурации, но у Fabric исторически нет единого стандарта для этого. Из-за этого создателям кроссплатформенных модов приходится писать отдельный код настроек для каждого лоадера, тратя много времени на рутину. Библиотека Forge Config API Port решает эту проблему, перенося проверенный временем конфигурационный интерфейс Forge на Fabric и Quilt.

Как работает библиотека

Forge Config API Port выступает посредником между кодом модификации и файловой системой игры. Она полностью воссоздает оригинальные пакеты net.minecraftforge.common.ForgeConfigSpec и net.neoforged.fml.config в среде Fabric. Разработчик пишет описание конфигурации всего один раз, используя стандартный синтаксис Forge, а библиотека автоматически создает соответствующие файлы на диске и управляет их загрузкой.

Формат конфигурационных файлов TOML

Библиотека сохраняет все настройки в формате TOML. Этот формат предлагает удобную структуру для чтения и редактирования с помощью обычного текстового редактора. Каждый параметр может содержать комментарии, значения по умолчанию, а также четкие границы допустимых значений (минимальное и максимальное число). Файлы конфигурации автоматически появляются в папке config внутри главного каталога игры после первого запуска модификации. Они имеют расширение .toml и имя, указанное разработчиком мода.

Автоматическая синхронизация и динамическая перезагрузка

Одной из важнейших особенностей Forge Config API Port является встроенная поддержка синхронизации и динамической перезагрузки конфигураций:

• Синхронизация между сервером и клиентом (Sync): когда игрок подключается к серверу, сервер автоматически отправляет свои настройки клиенту. Это предотвращает возникновение конфликтов из-за разных версий конфигураций у игроков на сервере.

• Динамическая перезагрузка (Reload): библиотека отслеживает изменения в файлах TOML в реальном времени. Если вы отредактируете и сохраните файл конфигурации во время игры, Forge Config API Port незамедлительно обновит параметры в оперативной памяти без необходимости перезапускать клиент Minecraft.

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

Значение для игроков и разработчиков

Для обычных игроков Forge Config API Port не добавляет никакого видимого контента, новых блоков или предметов. Ее роль заключается в обеспечении работоспособности других модификаций. Без установки этой библиотеки игра просто не запустится, если другие моды ссылаются на ее классы. Модификация нужна в основном пользователям Fabric, так как Forge и NeoForge имеют эти функции по умолчанию в своей структуре.

Для разработчиков библиотека является незаменимым инструментом при создании кроссплатформенных проектов. Она позволяет:

1. Экономить сотни строк кода, которые ранее уходили на разработку отдельной логики сохранения настроек для разных лоадеров.

2. Обеспечивать одинаковый опыт администрирования модов для конечных пользователей, так как конфигурационные файлы имеют идентичную структуру на Fabric и Forge.

3. Использовать мощный инструментарий валидации значений Forge, который автоматически исправляет ошибочные вводы пользователей, возвращая параметры к значениям по умолчанию при сбоях.

Популярные зависимые модификации

Разработчик библиотеки, известный под ником Fuzs (или Fuzs_), использует ее во всех своих популярных модах. Вот несколько известных примеров:

• Easy Magic: мод, изменяющий механику стола зачарования, позволяя сохранять предметы внутри инвентаря стола и добавляя новые способы улучшения чар.

• Trading Post: блок, который объединяет торговые предложения всех окрестных жителей деревни в одном интерфейсе.

• Visuality: мод на визуальные эффекты, добавляющий реалистичные частицы грязи, искр и брызг воды от различных действий мобов.

• Easy Shulker Boxes: позволяет взаимодействовать с шалкеровыми ящиками напрямую из инвентаря без необходимости устанавливать их на землю.

Помимо проектов от Fuzs, сотни других разработчиков используют Forge Config API Port для переноса своих наработок с Forge на Fabric, благодаря чему игроки получают доступ к огромной библиотеке качественного контента.