SuperMartijn642's Config Lib - SuperMartijn642's Config Lib 配置库

SuperMartijn642's Config Lib 允许你只编写一次配置，然后它就会在不同世界加载之间处理值的重新加载、与客户端同步值，并且自动生成仅限客户端或仅限服务端的值。

创建配置：

配置使用 ModConfigBuilder 创建。

只需通过 #ModConfigBuilder() 创建一个新实例。

   ModConfigBuilder builder = new ModConfigBuilder();

可以通过 ModConfigBuilder#define 向配置中添加一个值，它接受名称和默认值。

对于整数和双精度值，还需要提供最小值和最大值。

ModConfigBuilder#define 会返回一个 Supplier，应将其保存下来以便从配置中获取该值。

   Supplier booleanValue = builder.define( "booleanValue", true );

   Supplier integerValue = builder.define( "integerValue", 5, 0, 10 );

   Supplier doubleValue = builder.define( "doubleValue", 0.5, 0, 1);

   Supplier enumValue = builder.define( "enumValue", ExampleEnum.VALUE_1 );

可以在定义值之前调用 ModConfigBuilder#comment(String) 为该值添加注释。

   Supplier valueWithComment = builder.comment( "this is a comment for 'valueWithComment'" ).define( "valueWithComment ", true );

默认情况下，值会在世界加载时重新加载。

如果想改为仅在 Minecraft 启动时重新加载该值，可以在定义值之前调用 ModConfigBuilder#gameRestart()。

   Supplier notReloadedValue = builder.comment( "this is value will not be reloaded" ).define( "notReloadedValue", true );

COMMON 或 SERVER 配置中的值默认会与客户端同步，如需阻止此行为，请使用 ModConfigBuilder#dontSync()。

   Supplier notSynchronizedValue = builder.comment( "this is value will not be synchronized" ).define( "notSynchronizedValue", true );

值也可以放入分类中。

ModConfigBuilder#push(String) 用于进入一个分类，ModConfigBuilder#pop() 用于退出一个分类。

   builder.push( "special" );
   
   Supplier specialValue = builder.comment( "this value is in the 'special' category" ).define( "specialValue", true );
   
   builder.pop();

可以使用 ModConfigBuilder#categoryComment(String) 为当前分类添加注释。

   builder.push( "client" ).categoryComment( "this, is a comment for the 'client' category" );

在定义完所有值之后，必须调用 ModConfigBuilder#build() 来完成配置。

   builder.build();

现在，你配置中的值将会自动重新加载并同步，而且可以通过保存下来的 Supplier 实例获取这些值。

这适用于所有可用版本，包括 Minecraft 1.12、1.14、1.15、1.16、1.17、1.18 和 1.19。

示例 Mod：

如果想看一个关于如何使用 Config Lib 的具体示例，请查看示例 mod。

常见问题

我可以在我的整合包中使用你的 mod 吗？

可以，欢迎在你的整合包中使用我的 mod

Discord

想了解未来内容、即将发布的 mod 以及参与讨论，欢迎加入 SuperMartijn642 的 discord 服务器！