Skip to content

自动界面(Cloth Config)

TritiumAutoConfig 能基于你的配置类自动生成 Cloth Config v15 配置界面。

快速使用

java
import me.zcraft.tc.config.TritiumAutoConfig;
import net.minecraft.client.gui.screens.Screen;

Screen screen = new TritiumAutoConfig(CONFIG).createConfigScreen(parent);
  • CONFIGTritiumConfig 的实例
  • createConfigScreen 返回可直接 push 的 Screen
  • 保存时会调用 config.save() 写回磁盘

控件映射

  • boolean → 开关(toggle)
  • int/long/double → 数值输入(支持 @Range 的最小/最大)
  • String → 单行文本框
  • enum → 下拉选择(显示枚举常量名)
  • List<String> → 字符串列表编辑器

默认值、tooltip 与标题均走本地化键,详见“国际化”。

分类与子分类

  • 顶层每个字段(若其内部存在可配置字段)会生成一个“分类”
  • @SubCategory 字段会以“折叠子分类”的方式呈现,并可递归嵌套

空分类占位

Cloth Config v15 要求至少存在一个分类。若扫描后未生成任何分类,库会自动添加一个名为 general 的占位分类,确保界面正常构建。

常见问题

  • 看不到我添加的某些项?
    • 检查是否被标记为 @ClientOnly 且当前为服务端环境
    • 检查是否写成了不受支持的类型(仅支持 boolean、数值、字符串、枚举、List<String>
  • 修改 UI 的值没落盘?
    • 该界面在保存时会调用 config.save(),请确认保存操作已触发