ConfigGuard

ConfigGuard

自动快照你的配置文件夹,提供逐行差异对比和一键恢复。可在客户端或服务器上撤销任何配置更改。

ConfigGuard

把你的配置搞坏了?两次点击即可回滚。

ConfigGuard 会自动为你的配置文件创建快照,并准确展示快照之间的改动。任意文件或整个文件夹都可以从快照恢复。它面向调整整合包的玩家、测试更新的整合包作者,以及手工编辑配置的服务器服主。

功能

  • 自动快照:游戏启动时(在 Fabric 上,会在其他模组加载并重写其文件之前)和关闭时创建。你也可以手动创建快照并为其添加标签。
  • 变更检测:如果游戏关闭期间配置文件发生了变化(整合包更新、手动编辑、其他启动器),会通知你有多少文件发生了改动。
  • 可视化差异:快照列表 → 自该快照以来发生变化的文件(新增、修改、删除)→ 逐行差异,删除的行标红,新增的行标绿。
  • 恢复单个文件或全部内容。恢复前,ConfigGuard 会将当前状态另存为快照,因此每次恢复都可以撤销。
  • 固定快照永不自动删除。达到数量上限后,旧的未固定快照会被清理。
  • 紧凑存储:文件按 SHA-256 哈希存储在 configguard/ 文件夹中,因此未发生变化的文件绝不会重复存储。

打开界面

  • Fabric:Mod Menu → ConfigGuard → 配置按钮(Mod Menu 为可选)。
  • NeoForge:模组 → ConfigGuard → 配置。
  • 任意加载器:在 控制 → 按键绑定 中为 打开 ConfigGuard 快照 设置按键(默认未绑定)。

服务器命令

面向管理员(权限等级 4),在专用服务器以及启用作弊的单人游戏中可用:

命令 作用
/configguard snapshot [label] 立即创建快照
/configguard list 列出快照,最新的在前(点击 id 查看其改动)
/configguard changes <id> 自该快照以来发生变化的文件
/configguard diff <id> <path> 在聊天中显示单个文件的行差异
/configguard restore <id> [path] 恢复单个文件或所有已更改的文件
/configguard pin <id> / unpin <id> 永久保留快照,或取消保留

快照 id 和文件路径支持 Tab 补全。恢复后请重启游戏或服务器,以便模组读取恢复后的文件。

设置

config/configguard.json(首次启动时创建):

键 默认值 作用
trackedPaths config、defaultconfigs、options.txt、server.properties 游戏文件夹中被捕获的文件和文件夹
excludedGlobs **.log、**.tmp、**.bak、**.lock、**.old 被跳过的文件
maxFileSizeKb 1024 超过此大小的文件会被跳过
maxSnapshots 40 保留多少个未固定快照
snapshotOnStartup true 游戏启动时创建快照
snapshotOnShutdown true 游戏关闭时创建快照
notifyExternalChanges true 通知游戏关闭期间发生的改动

兼容性

  • 可在客户端、专用服务器或两者上运行。无需在另一端安装。
  • Fabric:需要 Fabric API;Mod Menu 为可选。NeoForge:无依赖。
  • 适用于任何将设置保存在 config 文件夹中的模组:TOML、JSON、JSON5、properties 及其他文本格式会获得行差异;二进制文件会列出其大小。

许可证

MIT。欢迎将 ConfigGuard 包含在整合包中。