Simple Config

📖 关于

Simple Config 是一个前置模组，让模组开发者可以轻松地为自己的模组添加配置功能。它也让玩家能够轻松配置模组：提供强大的菜单和命令来编辑配置文件，甚至可以远程编辑；还允许玩家创建预设，或将复杂的配置修改绑定到快捷键上。

✅ 玩家功能

• 为所有模组 提供强大的配置菜单（只要它们使用 Forge 的配置 API）
• 像配置其他模组一样编辑Minecraft 选项/游戏规则
• 远程编辑服务器配置（需获得授权）
• 创建配置预设或补丁（部分预设）
• 创建快捷键，在游戏中修改任意设置（赋值、增加、切换、循环、乘算等）
• 通过命令访问配置
• 在服务器内分享预设/快捷键
• 搜索/筛选条目，并可在菜单和命令中撤销/重做更改
• 在菜单中检测、预览并合并外部更改（由其他玩家或在游戏外所做的更改）
• 配置文件可以使用翻译后的描述（需由模组或资源包提供）
• 替换其他模组的菜单（可按模组分别配置）

还推荐搭配使用 Catalogue，它能为默认的模组列表菜单带来很棒的升级。

📚 开发者功能

• 用于定义配置文件的简易构建器 API
• 基于注解的可扩展声明式 API
• 基于属性委托的安全声明式 Kotlin API
• 通过依赖注入将其作为软依赖 （Kotlin API 除外）
• 自动生成菜单和命令
• 自动烘焙到字段中（支持自定义转换）
• 自动为条目映射翻译键
• 使用泛型类型（列表/映射/键值对/Bean/数据类……）或自定义可序列化类型创建复合条目类型
• 提供多个默认预设/快捷键，方便玩家轻松设置配置

面向开发者的所有功能都记录在该模组 Wiki 中的模组开发者指南里。

👏 致谢

这个模组创建的配置菜单最初使用了 Cloth Config API。
后来，由于需要进行大量修改，我最终为这个模组将它彻底重写了（大约 3 次）</span；不过，如果你正在寻找图形界面 API，不妨去看看它！

最初，这个模组只是为了给使用其配置 API 的模组提供配置菜单。
我启动这个项目，只是因为我觉得在自己的 Aerobatic Elytra 模组中使用 Forge 的配置 API 太麻烦，而 Configured 当时还不存在。
不过，受 Configured 启发，我决定在自己的库之上添加一个简单的封装层，以支持使用 Forge 配置系统的任意模组。

之后，我还决定封装 Minecraft 选项，因为它们也没什么不同。（1.16 除外，1.16 选项的封装简直是个巨大的 hack）

📜 Fabric？

我计划将这个模组移植到 Fabric，但可能还需要一些时间。你可以在 GitHub 上关注这个问题以获取更新。

假设推出 Fabric 版本，它可能无法像在 Forge 上那样轻松地封装所有其他模组，因为 Fabric 中的配置文件并非都使用同一套框架。

当然，也可以根据配置文件本身推测其结构，但有时可能不够准确。

❓ 帮助

本项目提供了一个维基，其中包含面向玩家和模组开发者的详细指南。

此外，如果你遇到任何问题，或者只是想打声招呼，欢迎加入我们的Discord 服务器。

🤝 支持本项目

如果你想支持本项目，欢迎分享给朋友！

📷 图片

菜单

快捷键

命令

设置