Smootheez Config Lib

📦 Smootheez Config Lib (SCL)

一款旨在简化 Minecraft 模组配置管理的实用模组。
主要为我自己的模组开发，但也可供公众免费使用。

---

❓ SCL 是什么？

Smootheez Config Lib (SCL) 为 Minecraft 模组提供了更简单、更清晰的配置管理方式。
它省去了重复的样板代码，并提供了简单的接口来实现：

• ✅ 配置文件管理
• 🛠️ 自动生成配置界面
• ⚙️ 自动生成配置文件

---

🖼️ 游戏内预览

🔧 标准配置界面

📝 带说明的配置界面

🗂️ 编辑 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 匹配

---

📥 下载

• 🔗 Modrinth
• 🔗 CurseForge
• 📦 JitPack 发布版

---

🐞 问题追踪

发现了 Bug 或有功能建议？

在此提交问题：GitHub Issues

---

⚠️ 重要说明

• ✅ 兼容 Minecraft 1.20.1+
• 📜 采用 MIT 许可证

---

☕ 支持我

如果你觉得这个项目有帮助并想支持我的工作，可以考虑捐赠：