Config API

Config API - это, по сути, универсальный инструмент для разработчиков модов, который решает одну из самых головных болей при создании мультизагрузочных проектов. Вместо того чтобы писать отдельную систему конфигов под каждый загрузчик (Fabric, Forge, NeoForge, Quilt), ты используешь одно API, и оно само подстраивается под окружение.

Зачем это нужно?

В ванильном Майнкрафте нет встроенного GUI для настроек модов. Каждый моддер вынужден либо писать свой экран конфигурации с нуля, либо подключать сторонние библиотеки вроде Cloth Config. Проблема в том, что Cloth Config работает только на Fabric/Quilt, а на Forge/NeoForge нужно использовать их родные системы. Config API решает эту проблему - ты пишешь код один раз, а экран настроек появляется автоматически на всех платформах.

Что умеет Config API?

• Автоматически добавляет экран настроек - если мод использует это API, кнопка "Config" появляется сама собой в меню модов. Не нужно ничего дополнительно подключать.
• Поддержка трех типов конфигов: Client (только на клиенте), Common (везде) и Server (сохраняются в папке мира). Серверные конфиги особенно полезны для мультиплеера - можно задать настройки, которые будут работать только на конкретном сервере/мире.
• Дополнительные методы вроде getComments(), getKey(), getRange() - упрощают работу с конфигами.
• Кроссплатформенность - работает на Fabric, Forge, NeoForge и Quilt. Для Fabric требуется Fabric API.

Почему стоит выбрать Config API вместо родных систем Forge/NeoForge?

Главный плюс - автоматический экран настроек. В родных системах Forge и NeoForge его тоже можно сделать, но придется писать дополнительный код. Здесь он добавляется сам. Плюс методы вроде getComments() и getRange() дают больше гибкости при описании параметров.

Для разработчиков

Если ты моддер и хочешь добавить Config API в свой проект, вот краткая инструкция:

1. В build.gradle добавь плагин io.github.0ffz.github-packages версии 1.2.+
2. Пропиши репозиторий maven githubPackage.invoke("Craftjakob/Config-API")
3. Добавь зависимость под свой загрузчик:
   • Для Fabric: modImplementation "com.craftjakob:configapi-fabric:${mc_version}-${configapi_version}"
   • Для Forge: modImplementation "com.craftjakob:configapi-forge:${mc_version}-${configapi_version}"
   • Для NeoForge: modImplementation "com.craftjakob:configapi-neoforge:${mc_version}-${configapi_version}"
   • Для Quilt: modImplementation "com.craftjakob:configapi-quilt:${mc_version}-${configapi_version}"
   • Общая часть: modImplementation "com.craftjakob:configapi-common:${mc_version}-${configapi_version}"

Если не можешь использовать modImplementation, замени на compileOnly и runtimeOnly.

Важно знать

• Начиная с версии 2.4.0 добавлена поддержка Minecraft 1.21.2 и 1.21.3, но убрана поддержка фоновых конфигов из-за изменений в самой игре.
• Версия 2.0.0 принесла поддержку серверных конфигов и экран выбора мира для их редактирования.
• Формат файлов конфигов - .cfg, начиная с версии 1.1.0 (несовместим с v1.0.0).
• Для Fabric требуется Fabric API.

Итог

Config API - это удобный инструмент для моддеров, которые хотят сделать свои моды кроссплатформенными без лишней головной боли с конфигами. Если ты разрабатываешь мод под несколько загрузчиков - этот проект сэкономит тебе кучу времени. Скачайте Config API и упростите себе жизнь при создании мультизагрузочных модов для Майнкрафт.