WorldGit
WorldGit 是一款适用于 Minecraft 1.21.11 的 Paper 插件,为协作式世界建造引入了类 Git 的工作流。
玩家可以从受保护的主世界中分支出一个选定区域到隔离的分支世界中,安全地进行编辑,提交作品以供审核,并将已批准的更改合并回主世界。除了通过显式的合并操作外,主世界始终保持只读状态。
中文版请参阅 README.zh-CN.md。
目标环境
- Minecraft 服务器:Paper
1.21.11 - Java:
21 - 构建工具:Gradle Kotlin DSL + Shadow
- 主要依赖项:
- Paper API
1.21.11-R0.1-SNAPSHOT - WorldEdit
7.4.1-SNAPSHOT - Multiverse-Core
5.5.3 - SQLite JDBC
3.47.2.0
- Paper API
- 可选集成:
- LuckPerms API
核心功能
- 基于 WorldEdit 选区创建分支区域
- 在编辑阶段支持并发的重叠分支
- 用于编辑的隔离分支世界
- 基于书本的玩家菜单,包含分支详情、冲突中心、审核和合并历史等界面组件(以箱子 UI 形式呈现)
- 审核流程:提交、批准、拒绝、确认合并
- 基于区域的变基(rebase)至最新主世界版本,支持三方冲突检测
- 冲突组支持
mine(采用我的)、theirs(采用对方的)以及手动解决流程 - 合并前会重新检查已批准的分支;过期的批准将被撤销并要求重新审核
- 已批准的分支变为只读,除非使用
/wg forceedit - 支持基于告示牌的坐标输入,用于设置
Pos1/Pos2及合并消息 - 崩溃安全的合并日志和变基日志,支持启动恢复
- 共享分支访问权限的邀请系统
- 对受保护的主世界进行版本和提交跟踪
- 仅在合并期间持有短时间的集成锁
- 主世界保护机制以强制执行只读行为
- 定期和手动备份
运行时依赖
请在 Paper 1.21.11 测试服务器上安装以下插件:
- WorldEdit
- Multiverse-Core
- WorldGit
LuckPerms 是可选的,仅在你希望通过它来管理权限时才需要。
构建
./gradlew build
输出 JAR 包:
build/libs/worldgit-1.1.0.jar
安装
- 将构建好的 JAR 文件复制到服务器的
plugins/目录中。 - 确保
WorldEdit和Multiverse-Core也已安装。 - 启动服务器一次以生成
plugins/WorldGit/config.yml。 - 如有需要,请编辑配置文件。
- 重启服务器。
默认配置
main-world: "world"
max-region-size-x: 50
max-region-size-z: 50
use-full-height: false
max-active-branches: 2
backup:
enabled: true
interval-minutes: 30
max-backups: 10
directory: "backups"
branch-world:
prefix: "wg_"
database:
file: "worldgit.db"
命令
玩家命令
/wg create/wg abandon <id>/wg list/wg info <id>/wg submit [id]/wg confirm [id]/wg forceedit [id]/wg invite <player> [id]/wg uninvite <player> [id]/wg tp <id>/wg return
管理员命令
/wg review list/wg review approve <id> [note]/wg review reject <id> <note>/wg admin close <id>/wg admin assign <player>/wg admin list [player]/wg admin backup/wg admin locks/wg reload
玩家菜单
- 玩家会在快捷栏第 9 格收到一本菜单书。
- 右键点击书本以打开主玩家菜单。
- 分支卡片现在会打开专用的分支详情箱子界面。
Pos1/Pos2支持:- 左键点击使用当前玩家坐标
- 右键点击打开告示牌输入框
- 坐标语法支持绝对值、
~、~+n和~-n
- 分支详情暴露以下功能:
- 传送
- 变基
- 冲突中心
- 提交审核
- 确认合并
- 强制编辑
- 放弃分支
- 冲突中心暴露以下功能:
- 冲突组列表
- 接受我的修改 (
mine) - 接受对方的修改 (
theirs) - 传送到现场进行手动解决
- 标记为已解决
- 已批准的分支通过最终确认界面以及基于告示牌的合并消息输入进行合并。
- 左下角的纸张物品会打开分页的合并历史记录,包含:
- 建造者
- 审核者
- 合并者
- 合并消息
Pos1/Pos2- 返回分支世界的传送入口
权限
玩家权限
worldgit.branch.createworldgit.branch.abandonworldgit.branch.listworldgit.branch.infoworldgit.branch.submitworldgit.branch.confirmworldgit.branch.forceeditworldgit.branch.inviteworldgit.branch.tpworldgit.branch.return
管理员权限
worldgit.admin.reviewworldgit.admin.closeworldgit.admin.assignworldgit.admin.listworldgit.admin.backupworldgit.admin.locksworldgit.admin.reloadworldgit.admin.bypass
工作流
术语表
- WorldGit 1.1.0 使用 Rebase(变基) 作为产品术语,这是可以接受的,因为该插件有意采用了类 Git 的风格。
- 从技术上讲,这不是完整的 Git 提交历史重写。
- 它是分支世界相对于最新主世界版本的基于区域的三方重放(three-way replay):
base:分支创建或上次变基时捕获的快照ours:当前分支世界的方块theirs:最新的主世界方块
- 在面向用户的文档和界面中,最清晰的表述是:Rebase(同步至最新主世界)。
创建分支
- 站在主世界中。
- 使用 WorldEdit 选择一个长方体区域。
- 运行
/wg create。 - 在生成的分支世界中进行编辑。
变基与解决冲突
- 从玩家菜单打开分支详情界面。
- 如果自你的基础版本以来主世界有重叠更新,该分支将被标记为过期(stale)。
- 点击 Rebase(变基) 将你的区域重放到最新的主世界版本上。
- 如果可以自动合并,分支将立即变为干净状态。
- 如果仍有冲突,打开 Conflict Center(冲突中心)。
- 使用以下方式解决每个冲突组:
mine(采用我的)theirs(采用对方的)- 在游戏内手动修复,然后标记为已解决
- 一旦所有冲突组都得到解决,分支将再次变为干净状态。
提交、审核与合并
- 运行
/wg submit [id]或通过分支详情界面提交。 - 如果分支已过期,提交将被拒绝,直到重新变基(rebase)。
- 管理员审核该分支。
- 一旦获得批准,该分支将变为只读。
- 如果你希望在批准后继续编辑,请先运行
/wg forceedit [id]。 - 再次编辑后,重新提交该分支以进行新的审核。
- 如果在批准之后但在合并之前主世界发生了更改,批准将被自动撤销。
- 再次对分支进行变基,如有需要解决冲突,然后提交以供重新审核。
- 如果分支仍然处于最新状态,运行
/wg confirm [id],输入合并信息,并将其合并回主世界。
世界保护覆盖范围
该插件阻止在配置的主世界中直接进行编辑,包括:
- 放置方块和批量放置
- 破坏方块
- 桶的倒出/装入
- 骨粉和施肥更新
- 流体和方块状态的更改,如蔓延、消散、形成和流动
- 活塞
- 爆炸,包括 TNT 和火球式爆炸
- 悬挂实体,如画作和物品展示框
- 盔甲架的操作和损坏
- 刷怪蛋、发射器发射的刷怪蛋以及蛋壳孵化成小鸡
- 自然生物和怪物生成、刷怪笼以及试炼刷怪笼
- 巡逻队、袭击、增援以及类似的敌对生物生成
- 从主世界进入下界或末地
拥有 worldgit.admin.bypass 权限的管理员可以绕过玩家驱动的保护检查。
Paper 1.21.11 测试清单
环境设置
- 启动一个全新的 Paper
1.21.11服务器。 - 安装
WorldEdit、Multiverse-Core和WorldGit。 - 确认所有三个插件均无错误加载。
- 确认主世界名称与
config.yml中的匹配。
分支创建
- 以拥有
worldgit.branch.create权限的玩家身份加入。 - 在主世界中选择一个小的长方体区域。
- 运行
/wg create。 - 验证:
- SQLite 中存在分支记录
- 存在名为
wg_<id>的分支世界 - 选定的方块被正确复制
- 分支存在基础快照
- 分支存储了基础修订版本
保护
- 尝试在主世界中放置和破坏方块。
- 尝试在主世界中使用桶、骨粉、物品展示框和盔甲架。
- 验证除非玩家拥有
worldgit.admin.bypass权限,否则所有更改均被阻止。
变基、审核与合并
- 让玩家 A 和玩家 B 从同一区域创建重叠的分支。
- 让玩家 A 先编辑并合并。
- 在玩家 B 上运行
/wg submit。 - 验证提交被拒绝且分支标记为过期(stale)。
- 使用分支详情界面运行 Rebase(变基)。
- 如果出现冲突,验证冲突中心是否可以:
- 列出组
- 接受我的更改
- 接受他们的更改
- 传送以进行手动修复
- 标记某组已解决
- 分支清理干净后,再次提交。
- 通过
/wg review approve <id>进行批准。 - 在合并之前,让另一个重叠分支再次更新主世界。
- 运行
/wg confirm <id>。 - 验证批准被自动撤销,且分支必须重新变基并重新审核。
- 完成第二次变基并再次提交。
- 再次批准,然后合并。
- 验证:
- 玩家被安全移出
- 方块已合并到主世界
- 创建了临时的合并锁并已释放
- 记录了世界提交条目
- 合并后分支世界被卸载,如果需要可以从合并历史中重新打开
- 分支标记为
MERGED - 合并历史记录显示构建者、批准者、合并者、合并信息和区域坐标
恢复
- 开始一次合并。
- 在合并或变基过程中停止服务器。
- 重新启动服务器。
- 验证不完整的合并和变基状态能够干净地恢复。
备份
- 运行
/wg admin backup。 - 验证在配置的备份目录下出现了备份文件。
- 如果启用了定时备份,验证旧备份已被清理。
备注
- 当前仓库可以通过
./gradlew build构建。 - 尚未包含自动化单元测试。
- 仍应在安装了 WorldEdit 和 Multiverse-Core 的真实 Paper 1.21.11 服务器上进行运行时验证。
你是这个资源的作者?登录后可认领此资源。
相似资源
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
ExyliaPlugins 的库。
通过对话框或铁砧界面帮助你的 Anthme
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
用于绘制游戏内地图或在浏览器中随探索实时进行地图绘制的实时地图。
评论 0
登录后参与评分
还没有评论,来抢沙发吧