
配置云备份工具
一个简单的Minecraft模组,用于备份游戏配置文件,支持可配置的备份路径和WebDAV云备份,适用于客户端和服务端。
查看大图Config Cloud Backuper
一个用于备份游戏配置文件的简易 Minecraft 模组,支持可配置的备份路径和 WebDAV 云备份,适用于客户端和服务端。
功能特性
- 客户端 + 服务端命令支持 — 双方均可使用命令;服务端还支持
/server_config_backuper ...(需要 Fabric API) - 客户端向服务端上传 — 客户端可将本地备份上传至服务端存储;文件按玩家分别保存,保留数量可配置
- 可选 GUI — 安装 ModMenu 和 Cloth Config API,即可从 ModMenu 打开设置
- 备份游戏配置、模组配置、光影配置及更多文件夹(参见
config/config-cloud-backuper.json) - 备份压缩与旧备份自动清理
- WebDAV — 备份后自动上传(若启用),以及手动列出/上传/下载命令
- 安全检查 — 客户端上传仅接受
.zip,带大小限制和文件名净化;服务端校验 SHA-256 并写入审计日志
环境要求
- Minecraft 1.21.1
- Fabric Loader >=0.16.0
- Java 21+
- Fabric API(命令注册必需)
- ModMenu(可选)
- Cloth Config API(可选,仅在 ModMenu GUI 中需要)
命令(客户端/服务端)
命令归类为:remote cloud / remote server。
根命令前缀(为兼容性保留):
- 客户端:
/config_backuper - 服务端:
/config_backuper或/server_config_backuper(功能相同)
注意:命令前缀有意保留,以向后兼容现有脚本和使用习惯。云风格前缀可在后续大版本中引入,并配合别名过渡。
| 子命令 | 描述 |
|---|---|
backup |
执行本地备份并清理超过 maxBackups 的旧文件;若启用了 WebDAV 自动上传,则随后上传最新备份 |
list |
列出符合配置前缀/后缀的本地备份文件 |
config reload |
从磁盘重新加载 config-cloud-backuper.json 并刷新运行时实例 |
config show |
显示当前主配置值 |
config set <key> <value> |
更新并保存主配置(布尔值支持 true/false 等) |
remote cloud status |
显示 WebDAV 配置(密码已掩码) |
remote cloud list |
列出远程 WebDAV 目录中的文件 |
remote cloud upload [file] |
强制将本地备份文件(默认最新)上传至 WebDAV;仍需凭据 |
remote cloud download [file] |
将远程文件下载到本地备份目录(默认按名称最新) |
remote cloud set <field> <value> |
写入 config-cloud-backuper_webdav.json 中的字段:enabled、serverUrl、username、password、remotePath |
remote server status |
(客户端)查询服务端的客户端上传配置 |
remote server list |
(客户端)查询当前玩家在服务端已上传的备份 |
remote server upload [file] |
(客户端)将本地备份上传至服务端(默认最新) |
仅运行根命令而不带子命令会打印简要帮助。
服务端示例
/server_config_backuper backup:执行服务端备份/server_config_backuper list:列出服务端本地备份/server_config_backuper config show:显示当前服务端配置/server_config_backuper remote server status:显示客户端上传配置/server_config_backuper remote server list:显示你已上传的备份(需要 OP 等级 > 2)/server_config_backuper remote server set folder ./configcloudbackuper-backups/client-uploads:设置上传根目录/server_config_backuper remote server set maxPerPlayer 20:设置每位玩家的最大备份数
配置
主配置:config/config-cloud-backuper.json
WebDAV 配置:config/config-cloud-backuper_webdav.json
也可以使用上面的 config / remote cloud / remote server 命令编辑值。
通用与备份存储
主字段包括:includeGameConfigs、includeModConfigs、includeShaderPackConfigs、includeSchematics、include3dSkin、includeSyncmatics、includeDefaultConfigs、compressionEnabled、maxBackups、backupFolder、backupFilePrefix、backupFileSuffix。
客户端上传至服务端(主配置字段)
clientUploadToServerEnabled:允许客户端上传至服务端(默认true)clientUploadFolder:服务端存储上传备份的根目录(默认./configcloudbackuper-backups/client-uploads)clientUploadMaxBackupsPerPlayer:每位玩家最大备份数(-1表示无限制,默认10)
服务端存储结构:
<clientUploadFolder>/<playerName>/<backupFile>
WebDAV(config-cloud-backuper_webdav.json)
enabled— 在本地备份流程后自动上传最新备份serverUrl、username、password、remotePath— 服务器与路径设置
WebDAV 安全行为:
- 上传同时写入校验文件:
<filename>.sha256 - 下载先读取
.sha256,下载后校验 SHA-256;不匹配则删除文件并返回错误
整合包使用
你可以在整合包中自由包含此模组,无需申请许可。
开发
构建
cd fabric
./gradlew build
如需在本地客户端测试 ModMenu + Cloth GUI,本仓库已通过 modLocalRuntime 包含 Cloth。你仍需要在运行配置中添加 ModMenu(或使用 modRuntimeOnly)。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。