
简单配置库
轻松实现模组设置,自动生成配置界面
Simple Config Lib
Simple Config Lib 是一个用于 Minecraft 模组的库,旨在处理设置。它允许开发者使用普通的 Java 类描述配置,随后库会自动构建游戏内的设置界面,并负责保存和加载数据。
该项目的主要目标是让开发者免于例行实现设置系统,并在所有支持的平台上提供单一、可预测的结果。
该库支持 Fabric、Forge 和 NeoForge 加载器。
详细文档可在 wiki 中查看:Simple Config Lib Wiki
用途
该库提供了一种统一的方式来处理模组设置,涵盖配置描述、存储和显示。
Simple Config Lib 为解决此任务提供了单一方法:
- 配置以类形式描述一次;
- 设置界面自动生成;
- 数据无需额外代码即可保存和加载;
- 在 Fabric、Forge 和 NeoForge 上行为保持一致。
这种方法让开发者能够专注于模组的功能,而不是其设置背后的基础设施。
适用对象
- 模组开发者 — 面向那些希望为用户提供便捷设置界面,而无需花费时间自行实现界面和文件处理的开发者。
- 玩家 — 该库是一个依赖项,通常因其他模组需要而安装。它无需单独配置,只需确保其他模组的设置正常工作。
特性
- 在类级别描述配置,并自动生成设置界面。
- 描述配置后只需一次调用即可获得现成的设置界面 — 库负责构建界面。
- 自动保存和加载值,无需手动处理文件。
- 在所有支持的加载器上行为一致。
- 基于配置结构自动本地化。
- 丰富的界面元素集,用于表示各种数据类型。
- 一组客户端辅助工具,简化界面创建。与配置本身一样,这些工具可以独立于游戏版本使用。
- 服务器端配置通过网络同步:标记为服务器端的配置存储在服务器上,在玩家加入时发送给每位玩家,并在客户端以只读方式显示,除非玩家拥有管理员权限。
- 与加载器和版本无关的网络层:将数据包描述为普通 Java record 并注册一次 — 库会构建编解码器、在每个加载器上注册,并处理双向发送。
安装
在 Fabric 加载器上,必须额外安装 Fabric API 才能使该库工作。在 Forge 和 NeoForge 上,无需额外依赖。
常见问题
玩家需要安装该库吗? 仅当其他模组需要时。Simple Config Lib 是一个依赖项,无需单独配置 — 它只是让使用它的模组的设置正常工作。
该库可以添加到整合包中吗? 可以。只要提供其原始页面的链接,该库就可以包含在整合包中。
该库会与其他模组冲突吗? 不会。Simple Config Lib 不会干扰其他模组,也不会与它们冲突。
我需要为不同版本和加载器编写不同的代码吗? 不需要。配置和辅助工具均设计为独立于游戏版本和加载器使用 — 相同的代码在所有地方都能工作。
在哪里报告错误和建议? 错误和建议可以在 GitHub 上报告。
项目状态
Simple Config Lib 最初是为我自己的项目创建的。我不得不接手它,因为许多现有库在最新版本的 Minecraft 上不再支持 Forge。
该项目是开放的并持续发展:功能集将扩展,发现的任何错误都将得到修复。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。