Мод Konfig 0.5.0+26.2 +4

Konfig — библиотека конфигурации для модов Minecraft. Согласно официальному описанию, она предназначена для объявления типизированных параметров конфигурации, их сохранения в формате TOML, синхронизации отдельных значений и генерации экранов настройки. Проект относится к категории утилит и распространяется по лицензии MIT.

Настоящее руководство основано исключительно на предоставленной фактической основе. Там, где официальные материалы не содержат подробностей, это прямо указано. Ниже рассматриваются назначение проекта, совместимость, установка, опубликованные возможности, ограничения и практический порядок проверки совместимости без предположений о внутренней реализации.

Назначение Konfig​

Официальное описание определяет Konfig как многозагрузочную библиотеку конфигурации для модов Minecraft.

Её задача состоит в том, чтобы предоставить разработчикам единый механизм работы с настройками независимо от поддерживаемого загрузчика. При этом специфичная для загрузчика интеграция остаётся в соответствующей части проекта, тогда как объявление конфигурации, проверка данных, миграция, сведения о синхронизации и описание экранов могут располагаться рядом с общей логикой мода.

В предоставленной информации Konfig рассматривается именно как библиотека, а не как самостоятельный игровой мод с собствеными механиками.

Скриншоты и внешний вид​

Принцип работы на высоком уровне​

Официальное описание позволяет выделить несколько основных направлений работы библиотеки.

Типизированные значения​

Konfig поддерживает объявление типизированных параметров конфигурации.

Среди перечисленных типов присутствуют:

• логические значения;

• числовые значения;

• перечисления;

• строки;

• списки строк;

• цвета RGB и ARGB;

• пользовательские кодеки.

Документация не раскрывает внутренний механизм хранения или обработки этих типов, поэтому дополнительные выводы делать нельзя.

Работа с файлами конфигурации​

Согласно официальному описанию, конфигурация сохраняется в виде файлов TOML с комментариями.

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

Синхронизация​

Библиотека поддерживает встроенные режимы синхронизации:

• NONE;

• LOGIN;

• LOGINANDRELOAD.

Из описания следует, что отдельные параметры могут синхронизироваться с клиентами.

При этом официальные материалы не раскрывают внутреннюю реализацию передачи данных или правила выбора конкретного режима.

Генерация экранов​

Konfig позволяет автоматически создавать экраны конфигурации для зарегистрированных объектов.

Также официально перечислены поддерживаемые элементы интерфейса:

• заголовки;

• изображения;

• поясняющий текст;

• всплывающие подсказки;

• расширенные информационные панели;

• интерактивные ссылки.

Документация не описывает внешний вид экранов или порядок их отображения в различных модах.

Основные возможности​

В официальном перечне возможностей указаны:

• типизированные параметры конфигурации;

• области конфигурации CLIENT, COMMON и SERVER;

• сохранение в TOML с комментариями;

• встроенные режимы синхронизации;

• версионирование схем;

• пошаговые миграции;

• автоматическая генерация экранов настройки;

• встроенные подсказки;

• расширенные информационные панели;

• интеграция с Fabric Mod Menu;

• вспомогательные кнопки конфигурации для Forge и NeoForge.

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

Совместимость​

Для опубликованных файлов подтверждены следующие версии Minecraft:

• 26.2;

• 26.1.2;

• 26.1.1;

• 26.1;

• 1.21.11.

В рамках выбранных файлов подтверждён только один загрузчик:

• NeoForge.

Хотя официальный текст проекта упоминает поддержку нескольких загрузчиков в целом, данная фактическая основа относится именно к опубликованным сборкам NeoForge. Поэтому утверждать наличие других опубликованных файлов в рассматриваемом наборе нельзя.

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

Зависимости​

В метаданных выбранных версий обязательные project dependencies отсутствуют.

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

Следует отличать это от примеров подключения библиотеки в проектах разработчиков. Они описывают использование Konfig при разработке модов, но не являются списком обязательных зависимостей опубликованных файлов.

Установка​

Для опубликованных файлов указан стандартный способ установки.

Практический порядок выглядит следующим образом:

• определить используемую версию Minecraft;

• убедиться, что используется совместимый NeoForge;

• выбрать сборку Konfig, соответствующую версии игры;

• поместить файл в папку mods;

• запустить игру.

Другие способы установки официально не описаны.

Практическая проверка совместимости​

При отсутствии дополнительных сведений рекомендуется использовать только подтверждённые признаки совместимости.

Перед использованием можно последовательно проверить:

• соответствует ли версия Minecraft одной из подтверждённых;

• используется ли NeoForge;

• совпадает ли версия опубликованного файла с версией игры;

• определяется ли библиотека загрузчиком при запуске.

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

Также опубликованные файлы различаются по версии и контрольным суммам, поэтому следует выбирать именно ту сборку, которая соответствует используемой версии Minecraft.

Версии​

В предоставленных материалах опубликованы сборки серии 0.5.0.

Подтверждены следующие варианты:

• 0.5.0+26.2;

• 0.5.0+26.1.2;

• 0.5.0+26.1.1;

• 0.5.0+26.1;

• 0.5.0+1.21.11.

Суффикс после знака «+» соответствует целевой версии Minecraft для конкретного файла.

Ограничения​

При использовании библиотеки следует учитывать несколько ограничений.

Ограниченность опубликованных сведений​

Предоставленная фактическая основа не содержит информации о:

• требованиях к оперативной памяти;

• производительности;

• внутренних алгоритмах работы;

• дополнительных настройках;

• пользовательских командах.

Поэтому подобные сведения не должны добавляться в руководство.

Требования к версии​

Использовать следует только ту сборку, которая соответствует версии Minecraft и опубликованному загрузчику.

Для остальных сочетаний официальных подтверждений в предоставленной основе нет.

Лицензия​

Konfig распространяется по лицензии MIT.

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

Безопасность​

Для опубликованных файлов приведены контрольные суммы SHA-512 и SHA-1.

Файлы этой карточки загружены с официального HTTPS-источника; размеры и опубликованные SHA-1/SHA-512 сверены, целостность и безопасные пути внутри архивов проверены статически. Файлы не запускались, поэтому динамическое поведение не заявляется как протестированное.

При этом отсутствуют сведения о запуске опубликованных файлов или их динамическом тестировании.

Практически рекомендуется убедиться, что используется подходящая версия Minecraft, выбран совместимый файл, а контрольные суммы совпадают с опубликованными значениями.

FAQ​

Что представляет собой Konfig?​

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

Какие версии Minecraft подтверждены?​

Для опубликованных файлов подтверждены версии 26.2, 26.1.2, 26.1.1, 26.1 и 1.21.11.

Какой загрузчик поддерживается опубликованными файлами?​

В предоставленной фактической основе подтверждён NeoForge.

Есть ли обязательные зависимости?​

В метаданных выбранных опубликованных версий обязательные project dependencies отсутствуют.

Как определить подходящую сборку?​

Следует сопоставить используемую версию Minecraft с суффиксом версии опубликованного файла и убедиться в использовании NeoForge.

Известны ли требования к клиенту и серверу?​

Нет. В опубликованных метаданных для обеих сторон указано значение unknown.

Где хранятся конфигурации?​

Официальное описание указывает использование файлов TOML в каталоге config.

Подтверждено ли динамическое тестирование опубликованных файлов?​