简易配置库

简易配置库

简易配置库 是一个用于 Minecraft 模组、旨在处理设置的库。它允许开发者用普通的 Java 类来描述配置，之后库会自动构建一个游戏内的设置界面，并负责数据的保存和加载。

该项目的主要目标是让开发者从例行公事般地实现设置系统中解放出来，并在所有支持的平台上提供一个统一、可预测的结果。

该库支持 Fabric、Forge 和 NeoForge 加载器。

详细的文档可在 wiki 中找到：简易配置库 Wiki

---

目的

该库提供了一种统一的方式来处理模组设置，涵盖配置描述、存储和显示。

简易配置库为完成此任务提供了一种统一的方法：

• 配置通过类描述一次；
• 设置界面自动生成；
• 数据的保存和加载无需任何额外代码；
• 在 Fabric、Forge 和 NeoForge 上的行为保持一致。

这种方法使开发者能够专注于模组的功能，而不是其设置背后的基础设施。

---

适用对象

• 模组开发者 — 适用于那些希望为用户提供便捷设置界面，但又不想自己花时间实现界面和文件处理的开发者。
• 玩家 — 该库是一个依赖项，通常因为其他模组需要它而被安装。它不需要单独配置，只需确保其他模组的设置正常工作即可。

---

特性

• 在类级别描述配置，并自动生成设置界面。
• 一个现成的设置界面，在描述完配置后即可通过一次调用获得 — 库负责构建界面。
• 自动保存和加载值，无需手动处理文件。
• 在所有支持的加载器上行为一致。
• 基于配置结构的自动本地化。
• 丰富的界面元素集，用于表示各种数据类型。
• 一套客户端辅助工具，可简化界面的创建。与配置本身一样，这些工具可以独立于游戏版本使用。

---

安装

在 Fabric 加载器上，库要正常工作还需要额外安装 Fabric API。在 Forge 和 NeoForge 上，则不需要其他额外依赖。

---

常见问题解答

玩家需要安装这个库吗？ 只有当另一个模组需要它时才需要。简易配置库是一个依赖项，不需要单独配置 — 它只是让使用它的模组的设置能够正常工作。

这个库可以添加到模组包中吗？ 可以。只要提供了其原始页面的链接，该库就可以包含在模组包中。

这个库与其他模组冲突吗？ 不冲突。简易配置库不会干扰其他模组，也不会与它们产生冲突。

我需要为不同的版本和加载器编写不同的代码吗？ 不需要。配置和辅助工具都旨在独立于游戏版本和加载器使用 — 相同的代码在任何地方都能工作。

我应该在哪里报告错误和建议？ 可以在 GitHub 上报告错误和建议。

---

项目状态

简易配置库最初是为我自己的项目创建的。我不得不接手它，因为许多现有的库在最新版本的 Minecraft 上停止了对 Forge 的支持。

该项目是开放的并持续发展：功能集将不断扩大，发现的任何错误都将被修复。