JasonConfig

模组

· 作者 jeducklet

一个由 JSON 驱动的 Forge 配置系统的替代品

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

最新 jsconf-1.1.1-1.21.1.jar · 1.21.1 · NeoForge

一键开服(送7天)

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

面向开发者 ---

添加依赖项 [

    直接使用 CurseMaven,其仓库地址为:
    在 Files 部分使用所需版本的代码片段来添加依赖项

    示例(非本模组)
    implementation "curse.maven:cloth-config-348521:5987045"

]

与 Forge 配置系统的优缺点对比

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

  • 使用 JSON 而非 TOML,更加可靠(例如,Forge 配置不太支持空列表,使用时可能会出错)
  • 兼容读取和写入的 Java / Minecraft 类比 Forge 配置多得多(例如,Vec3 无法写入或从 Forge 配置中读取,而 JasonConfig 由于基于 JSON 对象,对此毫无问题)
  • 在代码中编写更简单,同时仍与你创建 Forge 配置类的方式类似(见下文)

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

  • 由于采用 JSON 格式,对用户来说可读性稍差
  • 属于实验性功能,虽然我目前尚未发现 bug 但肯定会出现一些,毕竟我只是一个人
  • 不支持侧向(sided)配置。技术上讲,如果你仅在某一侧使用某个值,它将采用该侧的配置版本(因此专用服务器和客户端专用配置应能正常工作),但不存在像 “serverconfigs” 那样按世界区分的配置机制

配置示例(一旦将其添加到你的依赖项中,也可以在模组的 "api" 包中找到)

"api" 包中的所有内容都有详细文档,请予以参考

public class SimpleExampleConfigClass {
public static final Config EXAMPLE_CONFIG = new Config(MODID + "-example_config");
// 以下配置值通过传入的 {<code>EXAMPLE_CONFIG</code>} Config 进行调用,这会自动将其添加到配置中
public static final ConfigValue<Float> EXAMPLE_FLOAT = new ConfigValue<>(10f, "exampleFloat", EXAMPLE_CONFIG);
// 注释按声明顺序放置,因此此注释将位于 {<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);
public static final ConfigComment VEC3_COMMENT = new ConfigComment("这是一个 Vec3!许多在 Forge 配置中无法工作的 Java 类在这里都可以正常工作!", EXAMPLE_CONFIG);
public static final ConfigValue<Vec3> EXAMPLE_VEC3 = new ConfigValue<>(new Vec3(123,123,123), "exampleVec3", EXAMPLE_CONFIG);

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

// 获取值的示例
// 显式方式(与 Forge 的配置非常相似)
SimpleExampleConfigClass.EXAMPLE_FLOAT.get();
}
}

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源