Smootheez Config Lib

Smootheez Config Lib (SCL) — это вспомогательная библиотека, предназначенная для упрощения управления конфигурациями при разработке модов для Minecraft.

Smootheez Config Lib (SCL) предоставляет более простой и чистый способ управления конфигурациями для модов. Библиотека избавляет разработчиков от необходимости писать шаблонный код (boilerplate) и предлагает удобный интерфейс для автоматизации процессов.

Основные возможности библиотеки включают:

• ✅ Управление файлами конфигурации
• 🛠️ Автоматическая генерация экранов конфигурации
• ⚙️ Автоматическая генерация самих файлов конфигурации

🖼️ Игровые примеры

🔧 Стандартный экран конфигурации

📝 Экран конфигурации с описаниями

🗂️ Редактирование значения в OptionList

➕ Добавление значения в OptionList

❗ Экран подтверждения

🚀 Начало работы

🏗️ Шаг 1 – Добавление репозитория в build.gradle:

repositories {
    maven {
        url "https://jitpack.io"
    }
}

📦 Шаг 2 – Добавление зависимости с использованием версии из gradle.properties:

dependencies {
    modImplementation "com.github.smootheez:scl:${project.scl_version}"
}

Или используйте версию напрямую:

dependencies {
    modImplementation "com.github.smootheez:scl:[version]"
}

💡 Пример использования

🧱 Шаг 1 – Создание класса конфигурации:

@Config(name = "example_config", gui = true)
public class ExampleConfig {
    public static final ConfigOption<Integer> INT_TEXT = ConfigOption.create("intText", 0, -5, 100);
    public static final ConfigOption<Double> DOUBLE_TEXT = ConfigOption.create("doubleText", 0.0, 0.0, 2.0);
    public static final ConfigOption<Integer> INT_SLIDER = ConfigOption.create("intSlider", 0, -5, 100).asSlider();
    public static final ConfigOption<Double> DOUBLE_SLIDER = ConfigOption.create("doubleSlider", 0.0, 0.0, 2.0).asSlider();
    public static final ConfigOption<Double> DOUBLE_SLIDER_PERCENTAGE = ConfigOption.create("doubleSliderPercentage", 0.0, 0.0, 2.0).asSliderPercentage();
    public static final ConfigOption<Boolean> BOOLEAN = ConfigOption.create("boolean", false);
    public static final ConfigOption<OptionList> LIST = ConfigOption.create("list", "example_value_1", "example_value_2", "example_value_3");
    public static final ConfigOption<ExampleEnum> ENUM = ConfigOption.create("enum", ExampleEnum.EXAMPLE_VALUE_1);
}

🧩 Шаг 2 – Регистрация конфигурации в fabric.mod.json:

"entrypoints": {
    // ...existing entrypoints
    "scl": [
        "dev.smootheez.scl.example.ExampleConfig"
    ]
}

SCL автоматически сгенерирует файл конфигурации и экран настройки (требуется ModMenu).

⚠️ Важно: Экран настройки будет создан только если:

• Установлен параметр gui = true
• Имя конфигурации (name) совпадает с ID вашего мода