模组设置管理器

模组设置管理器

为每个模组的config.json提供一个游戏内设置窗口:复选框、带-/+步进器的数字字段、文本字段和下拉菜单,并配有应用、还原和重置按钮。可直接配合现有模组使用。可选的附属文件可添加标签、范围和实时应用功能。MIT许可。

实用

Mod Settings Manager

为每个模组的 config.json 提供游戏内设置窗口。 使用 /modsettings 打开它,选择一个模组,用真实的控件修改其设置,然后点击应用。再也不用为了手动编辑 JSON 而停服了。

它可以直接与模组现有的状态配合工作。任何在其数据文件夹中保留 config.json 的模组都会在第一天就显示出来,并且会为每个值选择相应的控件。模组不需要为此编写任何代码,也不依赖于它。

功能

  • 一个窗口管理所有模组。 模组列在左侧,并带有一个搜索框,也可以搜索单个设置项。所选模组的设置按分区显示在右侧。
  • 真实控件: 复选框、带 -/+ 步进器的数字字段(遵循每个设置的步长和范围)、文本字段和下拉菜单。列表和嵌套对象以只读方式显示。
  • 应用、还原、重置为默认值。 未应用的更改会标记为 *,直到你应用它们。
  • 先验证。 在写入任何内容之前,会检查类型、范围和允许的选项。如果某个值无效,则不会保存任何内容,并会告知你原因。
  • 安全写入。 旧文件保留为 config.json.msm-bak。新文件写入临时文件,然后重命名到位。键的顺序、未知键和文件的缩进都会保留。
  • 每次更改都有记录。 changes.log 每次更改记录一行:时间、玩家、模组、键、旧值、新值。
  • 重启横幅。 它列出了仅在重启后才会生效的更改。
  • 回写检查。 某些模组在关闭时会保存其设置并撤销你的编辑。重启后,Mod Settings Manager 会注意到并警告你。
  • 权限。 任何人都可以查看。更改设置需要管理员状态或 modsettings.edit 权限。
  • 也支持控制台命令: list、show、set 和 reload。

致模组作者:无需依赖即可获得更好的设置

你的模组已经可以正常工作。为了让其页面更美观,可以在你的 jar 中附带一个小的附属文件,Settings/<Group>_<Name>.settings.json:

例如,一个键可以这样描述:标签为 Day length (seconds),分区为 Turns,一个从 60 到 7200、步长为 60 的整数,默认值 1200,实时应用。另一个键可以是 enemy 或 any 的下拉菜单,内部键可以被隐藏。

附属文件是纯数据。当未安装 Mod Settings Manager 时,不会有任何东西读取它,因此它对你的模组没有任何成本。它提供标签、工具提示、分区、范围、下拉菜单、默认值和重启标志。它会根据已发布的 JSON schema 进行验证,损坏的附属文件会通过一条清晰的日志行报告。

为了无需重启即可应用更改,请在你的插件类中添加一个公共方法。它不需要从此模组导入任何内容:

public boolean onSettingsChanged(Map<String, Object> changed):重新读取你的配置,如果更改立即生效则返回 true,如果需要重启则返回 false。

完整指南(每个字段、嵌套值的点分键、验证规则和钩子的线程处理)在 GitHub 上的 SIDECAR.md 中,并带有一个完整的示例附属文件。它也在下载的 zip 中,连同 JSON schema 一起。

安装

  1. 将 ModSettingsManager-1.0.1.jar 放入你服务器的 mods 文件夹(单人游戏:%APPDATA%\Hytale\UserData\Mods\)。
  2. 启动服务器一次,以便你的模组写入它们的配置。
  3. 输入 /modsettings。

命令和权限

命令 作用
/modsettings 或 /msm 打开窗口
/modsettings <mod> 在某个模组上打开它
/modsettings list 列出有设置的模组
/modsettings show <mod> 打印模组的设置
/modsettings set <mod> <key> <value> 更改一个设置(可从控制台使用)
/modsettings reload 重新查找模组、配置和附属文件

权限: 任何人都可以打开窗口并查看。应用更改需要管理员状态或权限 modsettings.edit。服务器控制台始终可以更改设置。

兼容性

  • Hytale 服务器 0.7.3。
  • 适用于专用服务器和单人游戏。
  • 适用于任何在其数据文件夹中保留 JSON 配置的插件(mods/<Group>_<Name>/config.json,或附属文件指定的路径)。将设置存储在其他位置或其他格式的模组不会显示。
  • 无依赖。它不添加任何替换原版资源的资源;窗口使用原版 UI 样式。
  • 列表和嵌套对象在此版本中为只读。数字使用带 -/+ 步进器的数字字段(每次点击一步);目前还没有滑块。

许可证

MIT,版权所有 (c) 2026 Hledjolf。附属文件格式及其 schema 也是 MIT,因此任何模组,无论开源与否,都可以附带附属文件。

源代码和问题跟踪器:https://github.com/Hledjolf/ModSettingsManager