ZConfig

Мод ZConfig для Minecraft — управления конфигурациями

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

Основная цель и преимущества

ZConfig — это универсальный плагин для создания файлов конфигурации, вдохновлённый внутренней системой c2me. Его главная задача — упростить разработку модов и оптимизировать их размер. Разработчик отмечает, что использование ZConfig позволяет сократить размер зависимого мода (например, zfastnoise) до нескольких десятков килобайт. Пользователи получают только один файл конфигурации, не дублируя библиотеки настроек в каждом отдельном моде.

Возможности работы с настройками

Плагин использует файлы конфигурации в формате TOML и поддерживает создание записей различных типов, включая булевы значения (boolean) и целые числа (int). Для числовых параметров можно задавать ограничения диапазона, предотвращая ввод некорректных значений. Также ZConfig позволяет маркировать моды как несовместимые с определёнными настройками, помогая пользователям избегать конфликтов конфигурации.

Переопределение настроек другими модами

Ключевой особенностью является возможность другим модам переопределять конфигурационные записи через метаданные (fabric.mod.json). Разработчик может указать в секции "custom" ключ "zfastnoise:overrides", чтобы отключить конкретные опции миксинов (например, mixin.perf.surface) при установке определённого мода, повышая производительность без изменения исходного кода.

Пример кода на Java

В источнике приведён пример класса, расширяющего ConfigEntries. Здесь создаются записи BooleanConfigEntry и IntConfigEntry с комментариями, значениями по умолчанию и ограничениями. Инициализация объекта Config происходит через ConfigLoader и OverrideCollector, после чего можно загружать и получать значения настроек.

Планы развития

В будущем планируется добавить поддержку API конфигурации ModMenu и Forge, а также создать сборки для NeoForge. Разработчик также намерен добавить упрощённые механизмы для генерации конфигурационных файлов.

Связанные материалы

• Fabric API — похожий мод
• YetAnotherConfigLib (YACL) — похожий мод
• Fabric Language Kotlin — похожий мод

Лицензия: MPL-2.0