JasonConfig

模组

· 作者 Corrinedev

使用 JSON 数据结构的简单配置 API

1 本站下载 0 关注 更新于 1 年前

最新 1.1.1 · 1.20.6 · Forge

一键开服(送7天)

这是一个库类模组,如果你是普通用户,只需安装即可,无需阅读以下内容!

面向开发者 ---

添加依赖 [ 只需使用 CurseMaven,该仓库地址为: 在 Files 中使用所需版本的代码片段添加依赖 示例(非正确模组) implementation "curse.maven:cloth-config-348521:5987045" ]

与 Forge 配置相比的优缺点

-优点 ----------------------------------

使用 JSON 而非 TOML,使其更加可靠(例如,Forge 配置不易支持空列表,在使用时可能会出错)
能够读取和写入比 Forge 配置更多的 Java / Minecraft 类(例如,Vec3 无法写入或读取到 Forge 配置中,但由于 JSON 对象的原因,JasonConfig 没有这个问题)
在代码中编写更简单,同时仍与您创建 Forge 配置类的方式类似(见下文)

-缺点 ----------------------------------

由于采用 JSON 格式,用户可读性稍差
处于实验阶段,虽然我尚未发现任何错误,但我确信将来会出现一些问题,毕竟我只是一个人

示例配置(添加到依赖项后,也可以在模组的 “api” 包中找到)

“api” 包中的所有相关内容都有详细文档,请参考

public class ExampleConfigClass {
    public static final Config EXAMPLE_CONFIG = new Config(MODID + "-example_config");

    public static final ConfigComment DEVCOMMENT
            = new ConfigComment("此文件仅在开发环境中生成", EXAMPLE_CONFIG);

    ///以下配置值通过传入的 {<code>EXAMPLE_CONFIG</code>} Config 调用,这会自动将其添加到配置中
    public static final ConfigValue<Float> EXAMPLE_FLOAT
            = new ConfigValue<>(10f, "exampleFloat", EXAMPLE_CONFIG, new TypeToken<Float>(){}.getType());
    ///注释按照声明顺序放置,因此此注释将位于 {<code>EXAMPLE_FLOAT</code>} 下方且位于 {<code>EXAMPLE_LIST</code>} 上方
    public static final ConfigComment EXAMPLE_COMMENT
            = new ConfigComment("这是一个列表!", EXAMPLE_CONFIG);
    public static final ConfigValue<List<String>> EXAMPLE_LIST
            = new ConfigValue<>(List.of("value1", "value2", "value3", "value4"), "exampleList", EXAMPLE_CONFIG, new TypeToken<List<String>>(){}.getType());
    public static final ConfigComment VEC3_COMMENT
            = new ConfigComment("这是一个 Vec3!许多在 Forge 配置中不起作用的 Java 类在这里都可以正常工作!", EXAMPLE_CONFIG);
    public static final ConfigValue<List<Vec3>> EXAMPLE_VEC3
            = new ConfigValue<>(List.of(new Vec3(123,123,123), Vec3.ZERO), "exampleVec3", EXAMPLE_CONFIG, new TypeToken<List<Vec3>>(){}.getType());
    public static final ConfigComment CLASS_COMMENT
            = new ConfigComment("这是一个新创建的类,记录是保存此类数据的最佳方式", EXAMPLE_CONFIG);
    public static final ConfigValue<LinkedHashMap<String, Info>> EXAMPLE
            = new ConfigValue<>(new LinkedHashMap<>(Map.of("information", new Info(1.0f, false, 8))), "example", EXAMPLE_CONFIG, new TypeToken<LinkedHashMap<String, Info>>(){}.getType());

    ///此方法必须在您模组的主类中调用
    ///
    ///您需要对声明的 {<code>Config</code>} 调用 {<code>register()</code>} 方法
    ///如果您未在构造函数中分配,则还需添加您创建的任意 {<code>ConfigValue<?></></code>} 变量
    public static void init()/* 此方法可以命名为任何名称,如 init(), register() 等 */ {
        EXAMPLE_CONFIG.register();

        ///获取值的示例
        //显式(与 Forge 的配置非常相似)
    }

    public record Info(float f, boolean bool, int integer) { }
}

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源