a0fefd's ConfigLib

模组

· 作者 a0fefd

一个用于模组的配置库。提供添加配置选项的接口,以及用于与这些选项交互的图形用户界面(GUI)。

0 本站下载 0 关注 更新于 2 个月前

最新 1.0.2 · 26.1.2 · Fabric

一键开服(送7天)

ConfigLib

一个用于 Fabric 模组的轻量级配置库。以纯 Java 对象描述你的选项,即可获得可用的游戏内配置界面、用于打开界面的 /<modid> 命令以及 JSON 持久化支持,无需手动编写 GUI。

功能

  • 游戏内配置界面:按类别分标签页,并在每个标签页内使用子类别标题对相关选项进行分组。
  • 七种选项类型:BOOL(布尔值)、NUM(统一整数和浮点数)、STR(字符串)、ENUM(任意 Java 枚举)、LIST(列表)、TUPLE(元组)和 BUTTON(按钮)。
    • LIST 和 TUPLE 渲染为一组可展开的输入框,而非单个字符串字段,并且可以限制为特定的元素类型。最小/最大值钳制适用于每个条目(例如,将 RGB 值的每个分量钳制在 0-255 之间),而不仅仅是对单个 NUM 类型生效。
    • BUTTON 运行回调函数而不是存储值,适用于那些不需要保存到配置文件中的操作。
  • 自动注册命令:/<modid> 即可打开配置界面,无需额外设置。ConfigCommand.registerWithAlternatives 可以注册额外的命令别名来打开同一界面。
  • JSON 持久化:选项数据会往返保存至 <config dir>/<mod id>.json。如果文件损坏或版本过旧,则回退到默认值,而不会导致游戏崩溃。由于 BUTTON 不存储任何值,因此会被跳过。

安装方法

将这些内容添加到 build.gradle 文件的相应部分中:

repositories {
	mavenCentral()
	maven { url = "https://raw.githubusercontent.com/a0fefd/ConfigLib/mvn-repo/" }
}
dependencies {
	implementation "com.a0fefd:configlib:<version>"
}

将 <version> 替换为你目标使用的版本号。

用法

Config config = new Config("mymod", null);

config.builder.add(new ConfigOption<>(
        "example_toggle",
        "General",
        true,
        Boolean.class,
        ConfigOptionType.BOOL
));

config.load();
ConfigCommand.register(config);

仅凭上述代码即可使 /mymod 命令正常工作,并打开包含一个切换开关的配置界面。添加更多的 ConfigOptions 以提供更多设置项,并使用 category 和 subCategory 字段将大型配置组织成不同的标签页和区块。

要求

  • Minecraft 26.1.2
  • Fabric Loader 0.19.3 或更高版本
  • Fabric API
  • Java 25 或更高版本

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源