Configory

Configory

Конфигурация для модов Minecraft на основе соглашений.

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

public static final ConfigKey<Float> SPEED_MULTIPLIER =
        config.defineFloat("core.speed_multiplier", 1.0f)
                .range(0.1f, 10.0f)
                .describe("Global speed multiplier.")
                .register();

float speed = getConfig(SPEED_MULTIPLIER);
setConfig(SPEED_MULTIPLIER, 3.0f).save();

Нужен динамический доступ для отладочных инструментов или скриптов? Обращайтесь к той же конфигурации по строковому пути:

float speed = getConfig("core.speed_multiplier").asFloat();
setConfig("core.speed_multiplier", 3.0f).save();

Возможности

• Типизированные ключи конфигурации — чтение и запись значений с типовой безопасностью на этапе компиляции.
• Пути через точку — вкладывайте значения внутрь JSON-файла конфигурации или держите простой мод в одном плоском файле.
• Текучая валидация — объявляйте диапазоны и ограничения один раз; некорректные записи отклоняются.
• Сгенерированная командная поверхность — открывайте свою конфигурацию через собственную внутриигровую команду мода, без единой строчки шаблонного кода Brigadier.
• Файлы на основе JSON — читаемая человеком конфигурация с явным сохранением, чтобы вы контролировали момент записи.
• Изоляция по модам — каждый мод соответствует своему файлу конфигурации, чисто разделённому.
• Лёгкие соглашения начальной загрузки — минимум настроек для старта.

Примечания

Configory — библиотечный мод, не зависящий от загрузчика (зависит только от Gson и нацелен на Java 21). Компилируйтесь против него как против обычной зависимости, но не включайте его в сборку — поставляйте как обязательную зависимость и позвольте игрокам устанавливать jar Configory отдельно, чтобы несколько модов могли делить одну копию. Один jar загружается на Fabric, Forge и NeoForge и работает на очень широком диапазоне версий Minecraft.

Ссылки

• Документация: https://indemnity83.github.io/configory/
• Исходный код и проблемы: https://github.com/Indemnity83/configory

Иконка: book_scroll_written от Malcolm Riley, CC BY 4.0, увеличена.