Konfig

Konfig

Konfig — это мультилоадерная библиотека конфигурации для модов Minecraft.

Она позволяет модам объявлять типизированные значения конфигурации в общем коде, сохранять их в TOML с комментариями, синхронизировать выбранные значения с клиентами и генерировать экраны конфигурации для Fabric, Forge и NeoForge.

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

Что вы получаете

• Типизированные значения конфигурации для boolean, чисел, enum, строк, списков строк, цветов RGB/ARGB и пользовательских codec
• Области конфигурации с учётом стороны: CLIENT, COMMON и SERVER
• TOML-файлы с комментариями по пути `config//.toml`
• Встроенные режимы синхронизации: NONE, LOGIN и LOGIN_AND_RELOAD
• Версионирование схемы и пошаговые миграции
• Генерируемые экраны конфигурации для зарегистрированных handle
• Встроенные украшения экрана: заголовки, изображения, описательный текст и кликабельные URL
• Явные подсказки для строк сгенерированного экрана
• Насыщенные панели информации при наведении для глобальной, категорийной и специфичной для значения справки
• Интеграция с Fabric Mod Menu
• Помощники для кнопки конфигурации в Forge и NeoForge

Скриншоты

Поддерживаемые версии

Konfig 0.4.0 поддерживает все линейки Minecraft от 1.14.4 до 26.2.

• Fabric начинается с 1.14.4
• Forge начинается с 1.16.5
• NeoForge начинается с 1.21.1

Konfig использует один семантический релиз для всех поддерживаемых линеек Minecraft. Суффикс `+указывает, на какую версию Minecraft нацелен артефакт, например0.4.0+1.21.11или0.4.0+26.2`.

Быстрый пример

import com.iamkaf.konfig.api.v1.ConfigBuilder;
import com.iamkaf.konfig.api.v1.ConfigHandle;
import com.iamkaf.konfig.api.v1.ConfigScope;
import com.iamkaf.konfig.api.v1.ConfigValue;
import com.iamkaf.konfig.api.v1.Konfig;
import com.iamkaf.konfig.api.v1.RestartRequirement;
import com.iamkaf.konfig.api.v1.SyncMode;

public final class ExampleConfig {
    public static final ConfigHandle HANDLE;
    public static final ConfigValue<Boolean> ENABLED;
    public static final ConfigValue<Integer> RANGE;

    static {
        ConfigBuilder builder = Konfig.builder("examplemod", "common")
                .scope(ConfigScope.COMMON)
                .syncMode(SyncMode.LOGIN)
                .comment("Example mod config")
                .info(info -> info
                        .header("Example Mod")
                        .inlineText("These settings control shared gameplay behavior.")
                        .url("Documentation", "https://example.invalid/docs"));

        builder.header("Example Mod Settings");
        builder.inlineText("These entries are saved automatically.");
        builder.url("Documentation", "https://example.invalid/docs");

        builder.push("general");
        builder.categoryComment("General gameplay tuning");
        builder.categoryTooltip("General gameplay tuning");
        builder.categoryInfo(info -> info
                .header("General")
                .inlineText("Values in this section affect the whole mod."));

        ENABLED = builder.bool("enabled", true)
                .comment("Master toggle")
                .tooltip("Enable example mod features")
                .sync(true)
                .info(info -> info
                        .header("Master Toggle")
                        .inlineText("Turns the main feature set on or off."))
                .build();

        RANGE = builder.intRange("range", 8, 1, 64)
                .comment("Effect radius")
                .tooltip("Controls the effect radius in blocks")
                .sync(true)
                .restart(RestartRequirement.WORLD)
                .build();

        builder.pop();
        HANDLE = builder.build();
    }
}

Используй `ConfigValue#get()` при чтении значения и `ConfigValue#set(value)` при его программном изменении.

Комментарии записываются в TOML. Всплывающий текст на сгенерированном экране задаётся явно через `tooltip(...)` и более богатое содержимое `info(...)`, так что твои конфиг-файлы и подсказки в интерфейсе могут говорить разное, когда это нужно.

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

Добавь репозиторий Kaf Maven:

```groovy
repositories {
    maven { url = "https://maven.kaf.sh" }
}

Используй артефакт загрузчика для той линейки Minecraft, под которую делаешь:

modImplementation "com.iamkaf.konfig:konfig-fabric:<version>"
modImplementation "com.iamkaf.konfig:konfig-forge:<version>"
modImplementation "com.iamkaf.konfig:konfig-neoforge:<version>"

Не завись напрямую от common у Konfig. Используй артефакт для конкретного загрузчика.

Помоги перевести Konfig

Хочешь помочь перевести этот мод на свой язык? Присоединяйся к проекту сообщества по переводу:

Внести перевод

🇺🇸 🇪🇸 🇧🇷 🇫🇷 🇩🇪 🇷🇺 🇹🇷 🇯🇵 🇰🇷 🇨🇳

Вопросы и ответы

В: Где я могу спросить о том, чего здесь нет?

О: Создай issue здесь или зайди в Discord и напиши мне.

В: Можешь портировать это на [версию MC/загрузчик модов]?

О: Если достаточно людей попросят, я выделю на это время, но это реально команда из одного человека, так что может занять какое-то время.

В: Можно ли включить это в мой модпак?

О: Да, не нужно указывать авторство или спрашивать.

Другие мои моды

Bonded

Kaf's Valentine Special

Liteminer

Mochila

Torch Toss