RegionRestore
适用于 Paper/Folia 服务器的高性能世界区域还原插件
RegionRestore 是一款功能强大且专注于性能的插件,旨在以极快的速度将世界的部分区域恢复到原始状态。无论是管理 PvP 竞技场、小游戏大厅,还是需要进行可靠的世界状态重置,RegionRestore 都能在小规模区域还原时实现低于 10 毫秒的响应时间,同时在执行大规模操作时保持服务器的稳定性。
为什么选择 RegionRestore?
闪电般的还原速度
小型区域(如决斗竞技场)的还原时间在 10 毫秒以内,确保对游戏体验的影响降至最低。
区块流式传输技术
大型还原操作采用智能的 逐区块流式传输 机制,逐步加载并还原区块,而不是一次性全部加载。这防止了 Minecraft 区块系统过载,并在进行广泛的还原操作期间维持稳定的 TPS。
即时光照还原
与其他触发昂贵的光照重新计算方案的插件不同,RegionRestore 具备 即时光照还原 技术。这大幅降低了还原操作期间的 CPU 占用率,并消除了通常与光照更新相关的卡顿现象。
完美的竞技场管理方案
理想用途包括:
- PvP 决斗竞技场 - 比赛间即时重置
- 小游戏大厅 - 每局游戏后恢复大厅状态
- 活动竞技场 - 重置建筑、地形和结构
- 练习竞技场 - 快速环境重置
- 地块世界 (Plot Worlds) - 大批量地块再生
支持版本
| 平台 |
支持版本 |
| Paper |
1.21.4 - 26.1.1 |
| Folia |
1.21.4 - 26.1.1 |
Minecraft 版本支持
RegionRestore 使用 NMS 适配器以在特定版本上获得最佳性能:
- 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11, 26.1-26.1.1
注意: 该插件需要与您服务器版本匹配的 NMS 适配器。新版本 Minecraft 发布后不久将会推出相应的更新。
依赖项
基于 PaperMC 的服务器(例如 Paper、Purpur)
可选依赖
- PlaceholderAPI - 通过
%regionrestore_*% 占位符访问 RegionRestore 数据
- MiniPlaceholders - 在 MiniMessage 格式化的文本中使用
<regionrestore_*> 占位符
占位符
PlaceholderAPI 占位符
| 占位符 |
描述 |
%regionrestore_instance_count% |
实例总数 |
%regionrestore_instance_count_pooled% |
池化实例数量 |
%regionrestore_instance_count_manual% |
手动实例数量 |
%regionrestore_instance_count_<world>% |
特定世界的实例数量 |
%regionrestore_template_count% |
模板总数 |
%regionrestore_template_<name>_versions% |
某模板的版本数量 |
%regionrestore_template_<name>_active_version% |
某模板的活动版本 ID |
%regionrestore_pool_count% |
配置的池总数 |
%regionrestore_pool_<world>_<template>_count% |
特定池的实例数量 |
%regionrestore_pool_<world>_<template>_target% |
某池的目标实例数量 |
%regionrestore_pool_<world>_<template>_occupied% |
某池的已占用实例数量 |
%regionrestore_instance_<uuid>_world% |
实例所属的世界名称 |
%regionrestore_instance_<uuid>_template% |
实例使用的模板名称 |
%regionrestore_instance_<uuid>_occupancy% |
实例的占用计数 |
%regionrestore_instance_<uuid>_type% |
实例类型(池化/手动) |
%regionrestore_instance_<uuid>_originx% |
原点区块 X 坐标 |
%regionrestore_instance_<uuid>_originz% |
原点区块 Z 坐标 |
%regionrestore_instance_<uuid>_sizex% |
区块尺寸(X 轴) |
%regionrestore_instance_<uuid>_sizez% |
区块尺寸(Z 轴) |
%regionrestore_instance_<uuid>_minblockx% |
最小方块 X 坐标 |
%regionrestore_instance_<uuid>_maxblockx% |
最大方块 X 坐标 |
%regionrestore_instance_<uuid>_minblockz% |
最小方块 Z 坐标 |
%regionrestore_instance_<uuid>_maxblockz% |
最大方块 Z 坐标 |
MiniPlaceholders 占位符
| 占位符 |
描述 |
<regionrestore_instance_count> |
实例总数 |
<regionrestore_instance_count_pooled> |
池化实例数量 |
<regionrestore_instance_count_manual> |
手动实例数量 |
<regionrestore_template_count> |
模板总数 |
<regionrestore_pool_count> |
池总数 |
<regionrestore_instance_count_world:'world_name'> |
指定世界的实例数量 |
<regionrestore_pool_instance_count:'world':'template'> |
指定池的实例数量 |
<regionrestore_pool_target:'world':'template'> |
指定池的目标数量 |
<regionrestore_pool_occupied:'world':'template'> |
指定池的占用数量 |
<regionrestore_template_versions:'template_name'> |
指定模板的版本数量 |
<regionrestore_template_active_version:'template_name'> |
指定模板的当前活跃版本 |
命令
所有命令均使用 /regionrestore(或其别名 /rr、/arena、/arenas)。
GUI 命令
| 命令 |
描述 |
权限 |
/rr gui |
打开交互式管理 GUI |
regionrestore.gui |
该 GUI 提供直观的菜单导航,用于可视化地管理模板、实例、池和计时器。
模板命令
| 命令 |
描述 |
权限 |
/rr template create <name> <minX> <minZ> <maxX> <maxZ> [world] |
从世界坐标创建新模板 |
regionrestore.template.create |
/rr template list |
列出所有已保存的模板 |
regionrestore.template.list |
/rr template info <name> |
查看模板详情及版本 |
regionrestore.template.info |
/rr template setactive <name> <versionId> |
设置模板的活跃版本 |
regionrestore.template.setactive |
/rr template delete <name> |
删除模板 |
regionrestore.template.delete |
版本系统: 模板支持多个版本,允许你维护同一区域的不同快照。“活跃”版本是默认用于还原的版本。
还原命令
| 命令 |
描述 |
权限 |
/rr restore <template> [version/active] [scope] |
在原始位置还原模板 |
regionrestore.restore |
/rr restore at <template> <world> <x> <z> [version] |
在指定坐标还原模板 |
regionrestore.restore |
/rr restore in <template> <seconds> [version] [scope] |
设置倒计时并计划还原 |
regionrestore.restorein |
/rr restore version <template> [version/active] [scope] |
还原指定版本 |
regionrestore.restore |
受众范围:
NEARBY - 通知配置半径内的玩家
WORLD - 通知世界中所有玩家
SERVER - 通知所有在线玩家
NONE - 静默还原
实例命令
| 命令 |
描述 |
权限 |
/rr instance create <template> <chunkX> <chunkZ> [world] [version] [boot] [vacate] [interval] |
创建受追踪的区域实例 |
regionrestore.instance.create |
/rr instance list all |
列出所有实例 |
regionrestore.instance.list |
/rr instance list world <world> [type] |
列出指定世界中的实例 |
regionrestore.instance.list |
/rr instance info <instanceId> |
查看实例详情 |
regionrestore.instance.info |
/rr instance delete <instanceId> |
删除实例 |
regionrestore.instance.delete |
/rr instance restore <instanceId> |
触发实例的还原操作 |
regionrestore.instance.restore |
实例类型:
- Pooled(池化) - 自动管理的实例,用于批量克隆
- Manual(手动) - 单独创建和管理的实例
实例选项:
boot - 服务器启动时执行还原
vacate - 当所有玩家离开时执行还原
interval - 自动还原间隔(秒)
克隆器(池)命令
| 命令 |
描述 |
权限 |
/rr cloner status [world] |
查看池状态与配置 |
regionrestore.cloner.status |
/rr cloner restore [world] [template] |
触发池中实例的还原操作 |
regionrestore.cloner.restore |
/rr cloner regen [world] [--force] |
重新生成所有池实例 |
regionrestore.cloner.regen |
批量克隆器: 自动在已配置的多个世界中管理模板的多个副本(实例)。非常适合需要数十或上百个相同竞技场的决斗服务器。
计时器命令
| 命令 |
描述 |
权限 |
/rr timer set instance <instanceId> <intervalSeconds> [scope] |
为实例设置重复还原计时器 |
regionrestore.timer.set |
/rr timer set template <templateName> <intervalSeconds> [scope] |
为位于原始位置的模板设置计时器 |
regionrestore.timer.set |
/rr timer cancel id <instanceId> |
通过实例 ID 取消计时器 |
regionrestore.timer.cancel |
/rr timer cancel template-all <templateName> |
取消某模板的所有计时器 |
regionrestore.timer.cancel |
选择区域命令
| 命令 |
描述 |
权限 |
/rr selection wand |
获取选择法杖物品 |
regionrestore.wand |
/rr selection |
查看当前选择区域信息 |
regionrestore.selection |
/rr selection clear |
清除你的选择区域 |
regionrestore.selection |
/rr selection create <name> |
根据当前选择区域创建模板 |
regionrestore.template.create |
使用选择法杖:
- 右键点击以设置位置点(在 pos1 和 pos2 之间交替)
- 左键点击以查看当前选择区域信息
- 支持跨世界选择检测
调度功能
RegionRestore 提供了一套全面的调度系统,允许你基于各种触发器和条件自动化还原操作。
倒计时调度(延迟/定时还原)
安排还原操作在倒计时延迟后执行,并自动通知玩家。这允许你设定未来时间的还原计划,并在还原发生前警告玩家。
/rr restore in <template> <seconds> [version] [scope]
功能:
- 定时还原 - 按指定秒数延迟还原
- 可配置的广播节点 - 在特定时间点通知玩家(默认:60、30、10、5、4、3、2、1 秒)
- 受众范围控制 - 选择谁接收倒计时通知:
NEARBY - 配置半径内的玩家
WORLD - 世界中所有玩家
SERVER - 所有在线玩家
NONE - 静默倒计时
- 复数感知消息 - 自动处理“秒”的单复数语法
示例 - 安排竞技场在 30 秒后还原:
/rr restore in my_arena 30 WORLD
向所有玩家广播:“正在于 30 秒后还原区域...”,倒计时至“正在于 1 秒后还原区域...”
提示: 可用于计划内的维护、活动结束,或在还原前给予玩家时间完成当前活动。
重复/间隔调度
为实例或模板设置自动周期性还原。
/rr timer set instance <instanceId> <intervalSeconds> [scope]
/rr timer set template <templateName> <intervalSeconds> [scope]
功能:
- 基于实例 - 计时器跟随特定的区域实例
- 基于模板 - 在模板的原始位置创建一个隐藏实例
- 持久化 - 计时器在服务端重启后依然存在
- 可配置范围 - 每个计时器的受众通知设置
使用场景:
- 每 5 分钟重置一次的事件竞技场
- 每 60 秒自动重置的练习竞技场
- 定期刷新的大厅区域
取消方法:
/rr timer cancel id <instanceId> # 取消特定实例的计时器
/rr timer cancel template-all <name> # 取消某模板的所有计时器
启动还原
服务端启动时自动还原区域。
配置:
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
restore-on-boot=true
}
]
}
]
}
实例级别:
/rr instance create <template> <x> <z> [world] [version] true false [interval]
(第 5 个参数 true 启用启动还原)
使用场景:
- 服务端重启时重置所有竞技场
- 确保维护后地块处于清洁状态
- 将活动区域恢复到已知状态
清空还原
当所有玩家离开该区域时,自动还原区域。
工作原理:
- 实时跟踪区域内的玩家占用情况
- 监控区块移动、传送、世界切换、加入和退出事件
- 在所有玩家离开后 + 可配置的延迟时间触发还原
配置:
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
restore-on-vacate=true
}
]
}
]
}
实例级别:
/rr instance create <模板> <x> <z> [世界] [版本] [启动] true [间隔]
(第六个参数 true 启用撤离恢复)
配置选项:
mass-cloner {
vacate-delay-seconds=5 # 最后一名玩家离开后到恢复前的延迟时间(秒)
}
使用场景:
- 匹配结束后自动重置的决斗/PvP竞技场
- 完成后自动清理的小游戏实例
- 每次使用之间会自动刷新的私人竞技场
并发还原管理
通过智能限制并发还原数量,防止服务器过载。
配置:
restore {
max-concurrent-restores=5 # 最大同时进行的还原次数
}
行为:
- 当达到限制时,新的还原操作将被跳过,并发送可配置的提示通知
- 防止因过多同时进行区块操作而导致的 TPS 下降
- 还原操作会在有空闲槽位时自动排队并执行
通知:
玩家会收到一条消息,解释为何跳过了还原操作:
“区域还原已跳过:已达到最大并发还原数量(5)”
调度配置示例
示例 1:决斗竞技场与撤离
mass-cloner {
vacate-delay-seconds=3 # 最后一名玩家离开后延迟 3 秒
worlds=[
{
name="duels"
pools=[
{
template-name="1v1_arena"
count=20
restore-on-vacate=true
restore-on-boot=false
}
]
}
]
}
示例 2:事件竞技场与循环计时器
# 在指定位置创建实例
/rr instance create event_arena 100 100 events 0 false false
# 设置每 5 分钟循环一次的计时器,并发送 WORLD(世界)通知
/rr timer set instance <instance-id> 300 WORLD
示例 3:大厅与启动恢复 + 计时器
mass-cloner {
worlds=[
{
name="lobby"
pools=[
{
template-name="main_lobby"
count=1
restore-on-boot=true
restore-interval-seconds=3600 # 每小时恢复一次
}
]
}
]
}
示例 4:静默后台恢复
# 执行恢复操作且不发送任何通知
/rr restore in silent_arena 10 NONE
权限
完整权限列表
| 权限 |
描述 |
默认值 |
regionrestore.* |
授予所有 RegionRestore 权限 |
OP |
regionrestore.gui |
打开管理图形界面 |
OP |
regionrestore.template.create |
创建模板 |
OP |
regionrestore.template.list |
列出模板 |
OP |
regionrestore.template.info |
查看模板信息 |
OP |
regionrestore.template.setactive |
设置活动版本 |
OP |
regionrestore.template.delete |
删除模板 |
OP |
regionrestore.restore |
恢复模板 |
OP |
regionrestore.restorein |
计划定时恢复 |
OP |
regionrestore.instance.create |
创建实例 |
OP |
regionrestore.instance.list |
列出实例 |
OP |
regionrestore.instance.info |
查看实例信息 |
OP |
regionrestore.instance.delete |
删除实例 |
OP |
regionrestore.instance.restore |
触发实例恢复 |
OP |
regionrestore.cloner.status |
查看克隆器状态 |
OP |
regionrestore.cloner.restore |
触发池恢复 |
OP |
regionrestore.cloner.regen |
重新生成池 |
OP |
regionrestore.timer.set |
设置恢复计时器 |
OP |
regionrestore.timer.cancel |
取消计时器 |
OP |
regionrestore.wand |
使用选择法杖 |
OP |
regionrestore.selection |
管理选区 |
OP |
用例
决斗服务器
创建一个包含 50 个相同 PvP 竞技场的池,当玩家离开时自动恢复:
配置示例
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
count=50
separation-chunks=10
restore-on-vacate=true
}
]
}
]
}
事件竞技场
按计时器恢复竞技场并显示倒计时公告:
/rr timer set template event_arena 300 SERVER
练习服务器
在回合之间即时重置练习竞技场:
/rr restore template my_arena
剧情世界
服务器重启时重新生成所有地块:
示例配置
```hocon
mass-cloner {
worlds=[
{
name="plot_world"
pools=[
{
template-name="default_plot"
count=100
restore-on-boot=true
}
]
}
]
}
```
性能说明
- 小区域(小于 100 区块):恢复时间低于 10ms
- 大区域:使用区块流式传输以维持 TPS
- 光照更新:默认恢复原始光照(即时光照还原)
- 异步操作:可选完全异步恢复
- 区块卸载:自动清理以防止内存泄漏
支持
如需支持、功能请求或错误报告,请使用 GitHub Issue 跟踪器。
Discord(推荐):
网站:
电子邮件: pluginsupport@bruhmo.men
RegionRestore - 以游戏速度恢复你的世界。
RegionRestore
High-Performance World Region Restoration for Paper/Folia Servers
RegionRestore is a powerful, performance-focused plugin designed to restore parts of your world back to their original
state at exceptional speeds. Whether you're managing PvP arenas, mini-game lobbies, or need reliable world state resets,
RegionRestore delivers sub-10ms restoration for small regions while maintaining server stability even for massive
operations.
Why RegionRestore?
Lightning-Fast Restores
Small regions (like duels arenas) restore in under 10 milliseconds, ensuring minimal disruption to gameplay.
Chunk Streaming Technology
Large restores use intelligent chunk-by-chunk streaming that progressively loads and restores chunks rather than
loading everything at once. This prevents overloading Minecraft's chunk system and maintains consistent TPS even during
extensive restoration operations.
Instant Light Restoration
Unlike other solutions that trigger expensive light recalculation, RegionRestore features instant light restore
technology. This dramatically reduces CPU usage during restoration operations and eliminates the lag spikes commonly
associated with lighting updates.
Perfect for Arena Management
Ideal for:
- PvP Duels Arenas - Instant reset between matches
- Mini-Game Lobbies - Restore lobby state after each game
- Event Arenas - Reset builds, terrain, and structures
- Practice Arenas - Fast environment resets
- Plot Worlds - Mass plot regeneration
Supported Versions
| Platform |
Supported Versions |
| Paper |
1.21.4 - 26.1.1 |
| Folia |
1.21.4 - 26.1.1 |
Minecraft Version Support
RegionRestore uses NMS adapters for maximum performance on specific versions:
- 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11, 26.1-26.1.1
Note: The plugin requires a matching NMS adapter for your server version. Updates are released shortly after new
Minecraft versions.
Dependencies
A PaperMC based server (eg Paper, Purpur)
Optional
- PlaceholderAPI - Access RegionRestore data via
%regionrestore_*% placeholders
- MiniPlaceholders - Use
<regionrestore_*> placeholders in MiniMessage-formatted text
Placeholders
PlaceholderAPI Placeholders
| Placeholder |
Description |
%regionrestore_instance_count% |
Total number of instances |
%regionrestore_instance_count_pooled% |
Count of pooled instances |
%regionrestore_instance_count_manual% |
Count of manual instances |
%regionrestore_instance_count_<world>% |
Instance count for a specific world |
%regionrestore_template_count% |
Total number of templates |
%regionrestore_template_<name>_versions% |
Number of versions for a template |
%regionrestore_template_<name>_active_version% |
Active version ID for a template |
%regionrestore_pool_count% |
Total number of configured pools |
%regionrestore_pool_<world>_<template>_count% |
Instance count for a specific pool |
%regionrestore_pool_<world>_<template>_target% |
Target instance count for a pool |
%regionrestore_pool_<world>_<template>_occupied% |
Occupied instance count for a pool |
%regionrestore_instance_<uuid>_world% |
World name of an instance |
%regionrestore_instance_<uuid>_template% |
Template name of an instance |
%regionrestore_instance_<uuid>_occupancy% |
Occupancy count of an instance |
%regionrestore_instance_<uuid>_type% |
Instance type (pooled/manual) |
%regionrestore_instance_<uuid>_originx% |
Origin chunk X coordinate |
%regionrestore_instance_<uuid>_originz% |
Origin chunk Z coordinate |
%regionrestore_instance_<uuid>_sizex% |
Size in chunks (X) |
%regionrestore_instance_<uuid>_sizez% |
Size in chunks (Z) |
%regionrestore_instance_<uuid>_minblockx% |
Minimum block X coordinate |
%regionrestore_instance_<uuid>_maxblockx% |
Maximum block X coordinate |
%regionrestore_instance_<uuid>_minblockz% |
Minimum block Z coordinate |
%regionrestore_instance_<uuid>_maxblockz% |
Maximum block Z coordinate |
MiniPlaceholders Placeholders
| Placeholder |
Description |
<regionrestore_instance_count> |
Total number of instances |
<regionrestore_instance_count_pooled> |
Count of pooled instances |
<regionrestore_instance_count_manual> |
Count of manual instances |
<regionrestore_template_count> |
Total number of templates |
<regionrestore_pool_count> |
Total number of pools |
<regionrestore_instance_count_world:'world_name'> |
Instance count for a world |
<regionrestore_pool_instance_count:'world':'template'> |
Instance count for a pool |
<regionrestore_pool_target:'world':'template'> |
Target count for a pool |
<regionrestore_pool_occupied:'world':'template'> |
Occupied count for a pool |
<regionrestore_template_versions:'template_name'> |
Version count for a template |
<regionrestore_template_active_version:'template_name'> |
Active version for a template |
Commands
All commands use /regionrestore (or aliases /rr, /arena, /arenas).
GUI Command
| Command |
Description |
Permission |
/rr gui |
Open the interactive management GUI |
regionrestore.gui |
The GUI provides visual management of templates, instances, pools, and timers with intuitive menu navigation.
Template Commands
| Command |
Description |
Permission |
/rr template create <name> <minX> <minZ> <maxX> <maxZ> [world] |
Create a new template from world coordinates |
regionrestore.template.create |
/rr template list |
List all saved templates |
regionrestore.template.list |
/rr template info <name> |
View template details and versions |
regionrestore.template.info |
/rr template setactive <name> <versionId> |
Set the active version for a template |
regionrestore.template.setactive |
/rr template delete <name> |
Delete a template |
regionrestore.template.delete |
Versioning System: Templates support multiple versions, allowing you to maintain different snapshots of the same
region. The "active" version is used by default for restores.
Restore Commands
| Command |
Description |
Permission |
/rr restore <template> [version/active] [scope] |
Restore template at its original position |
regionrestore.restore |
/rr restore at <template> <world> <x> <z> [version] |
Restore template at specific coordinates |
regionrestore.restore |
/rr restore in <template> <seconds> [version] [scope] |
Schedule restore with countdown |
regionrestore.restorein |
/rr restore version <template> [version/active] [scope] |
Restore specific version |
regionrestore.restore |
Audience Scopes:
NEARBY - Notify players within configured radius
WORLD - Notify all players in the world
SERVER - Notify all online players
NONE - Silent restore
Instance Commands
| Command |
Description |
Permission |
/rr instance create <template> <chunkX> <chunkZ> [world] [version] [boot] [vacate] [interval] |
Create a tracked region instance |
regionrestore.instance.create |
/rr instance list all |
List all instances |
regionrestore.instance.list |
/rr instance list world <world> [type] |
List instances in a world |
regionrestore.instance.list |
/rr instance info <instanceId> |
View instance details |
regionrestore.instance.info |
/rr instance delete <instanceId> |
Delete an instance |
regionrestore.instance.delete |
/rr instance restore <instanceId> |
Trigger restore for an instance |
regionrestore.instance.restore |
Instance Types:
- Pooled - Auto-managed instances for mass cloning
- Manual - Individually created and managed instances
Instance Options:
boot - Restore on server startup
vacate - Restore when all players leave
interval - Auto-restore interval in seconds
Cloner (Pool) Commands
| Command |
Description |
Permission |
/rr cloner status [world] |
View pool status and configuration |
regionrestore.cloner.status |
/rr cloner restore [world] [template] |
Trigger restore for pool instances |
regionrestore.cloner.restore |
/rr cloner regen [world] [--force] |
Regenerate all pool instances |
regionrestore.cloner.regen |
Mass Cloner: Automatically manages multiple copies (instances) of a template across configured worlds. Perfect for
duels servers that need dozens or hundreds of identical arenas.
Timer Commands
| Command |
Description |
Permission |
/rr timer set instance <instanceId> <intervalSeconds> [scope] |
Set repeating restore timer for instance |
regionrestore.timer.set |
/rr timer set template <templateName> <intervalSeconds> [scope] |
Set timer for template at original position |
regionrestore.timer.set |
/rr timer cancel id <instanceId> |
Cancel timer by instance ID |
regionrestore.timer.cancel |
/rr timer cancel template-all <templateName> |
Cancel all timers for a template |
regionrestore.timer.cancel |
Selection Commands
| Command |
Description |
Permission |
/rr selection wand |
Get the selection wand item |
regionrestore.wand |
/rr selection |
View current selection info |
regionrestore.selection |
/rr selection clear |
Clear your selection |
regionrestore.selection |
/rr selection create <name> |
Create template from current selection |
regionrestore.template.create |
Using the Selection Wand:
- Right-click to set positions (alternates between pos1 and pos2)
- Left-click to view current selection info
- Supports cross-world selection detection
Scheduling Features
RegionRestore provides a comprehensive scheduling system that allows you to automate restores based on various triggers
and conditions.
Countdown Scheduling (Delayed/Scheduled Restores)
Schedule restores to happen after a countdown delay with automatic player notifications. This allows you to schedule
restores for a future time and warn players before restoration occurs.
/rr restore in <template> <seconds> [version] [scope]
Features:
- Scheduled Restore - Delay restoration by specified seconds
- Configurable Announce Points - Notify players at specific intervals (default: 60, 30, 10, 5, 4, 3, 2, 1 seconds)
- Audience Scope Control - Choose who receives countdown notifications:
NEARBY - Players within configured radius
WORLD - All players in the world
SERVER - All online players
NONE - Silent countdown
- Plurality-Aware Messages - Automatic "second/seconds" grammar
Example - Schedule arena restore in 30 seconds:
/rr restore in my_arena 30 WORLD
Announces to all players: "Restoring region in 30 seconds..." counting down to "Restoring region in 1 second..."
Tip: Use this for scheduled maintenance, event endings, or to give players time to finish their current activity
before the restore.
Repeating/Interval Scheduling
Set up automatic periodic restores for instances or templates.
/rr timer set instance <instanceId> <intervalSeconds> [scope]
/rr timer set template <templateName> <intervalSeconds> [scope]
Features:
- Instance-Based - Timer follows a specific region instance
- Template-Based - Creates a hidden instance at template's original location
- Persistent - Timers survive server restarts
- Configurable Scope - Per-timer audience notification settings
Use Cases:
- Event arenas that reset every 5 minutes
- Practice arenas that auto-reset every 60 seconds
- Lobby areas that refresh periodically
Cancellation:
/rr timer cancel id <instanceId> # Cancel specific instance timer
/rr timer cancel template-all <name> # Cancel all timers for a template
Boot Restoration
Automatically restore regions when the server starts.
Configuration:
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
restore-on-boot=true
}
]
}
]
}
Instance-Level:
/rr instance create <template> <x> <z> [world] [version] true false [interval]
(5th parameter true enables boot restore)
Use Cases:
- Reset all arenas on server restart
- Ensure plots are clean after maintenance
- Restore event areas to known state
Vacate Restoration
Automatically restore a region when all players leave it.
How It Works:
- Tracks player occupancy in real-time
- Monitors chunk movements, teleports, world changes, joins, and quits
- Triggers restore after all players have left + configurable delay
Configuration:
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
restore-on-vacate=true
}
]
}
]
}
Instance-Level:
/rr instance create <template> <x> <z> [world] [version] [boot] true [interval]
(6th parameter true enables vacate restore)
Configuration Options:
mass-cloner {
vacate-delay-seconds=5 # Delay after last player leaves before restoring
}
Use Cases:
- Duels/PvP arenas that auto-reset after matches
- Mini-game instances that clean up when finished
- Private arenas that refresh between uses
Concurrent Restore Management
Prevent server overload with intelligent concurrent restore limiting.
Configuration:
restore {
max-concurrent-restores=5 # Maximum simultaneous restores
}
Behavior:
- When limit is reached, new restores are skipped with configurable notification
- Prevents TPS drops from too many simultaneous chunk operations
- Restores automatically queue and execute when slots become available
Notification:
Players receive a message explaining why the restore was skipped:
"Region restore skipped: maximum concurrent restores (5) reached"
Scheduling Configuration Examples
Example 1: Duels Arena with Vacate
mass-cloner {
vacate-delay-seconds=3 # 3 second delay after last player leaves
worlds=[
{
name="duels"
pools=[
{
template-name="1v1_arena"
count=20
restore-on-vacate=true
restore-on-boot=false
}
]
}
]
}
Example 2: Event Arena with Repeating Timer
# Create instance at specific location
/rr instance create event_arena 100 100 events 0 false false
# Set 5-minute repeating timer with WORLD notifications
/rr timer set instance <instance-id> 300 WORLD
Example 3: Lobby with Boot + Timer
mass-cloner {
worlds=[
{
name="lobby"
pools=[
{
template-name="main_lobby"
count=1
restore-on-boot=true
restore-interval-seconds=3600 # Restore every hour
}
]
}
]
}
Example 4: Silent Background Restore
# Restore with no notifications
/rr restore in silent_arena 10 NONE
Permissions
Complete Permission List
| Permission |
Description |
Default |
regionrestore.* |
Grants all RegionRestore permissions |
OP |
regionrestore.gui |
Open the management GUI |
OP |
regionrestore.template.create |
Create templates |
OP |
regionrestore.template.list |
List templates |
OP |
regionrestore.template.info |
View template info |
OP |
regionrestore.template.setactive |
Set active version |
OP |
regionrestore.template.delete |
Delete templates |
OP |
regionrestore.restore |
Restore templates |
OP |
regionrestore.restorein |
Schedule timed restores |
OP |
regionrestore.instance.create |
Create instances |
OP |
regionrestore.instance.list |
List instances |
OP |
regionrestore.instance.info |
View instance info |
OP |
regionrestore.instance.delete |
Delete instances |
OP |
regionrestore.instance.restore |
Trigger instance restore |
OP |
regionrestore.cloner.status |
View cloner status |
OP |
regionrestore.cloner.restore |
Trigger pool restores |
OP |
regionrestore.cloner.regen |
Regenerate pools |
OP |
regionrestore.timer.set |
Set restore timers |
OP |
regionrestore.timer.cancel |
Cancel timers |
OP |
regionrestore.wand |
Use selection wand |
OP |
regionrestore.selection |
Manage selections |
OP |
Use Cases
Duels Server
Create a pool of 50 identical PvP arenas that auto-restore when players leave:
Example Configuration
mass-cloner {
worlds=[
{
name="duels_world"
pools=[
{
template-name="classic_arena"
count=50
separation-chunks=10
restore-on-vacate=true
}
]
}
]
}
Event Arena
Restore an arena on a timer with countdown announcements:
/rr timer set template event_arena 300 SERVER
Practice Server
Instantly reset practice arenas between rounds:
/rr restore template my_arena
Plot World
Mass regenerate all plots on server restart:
Example Configuration
```hocon
mass-cloner {
worlds=[
{
name="plot_world"
pools=[
{
template-name="default_plot"
count=100
restore-on-boot=true
}
]
}
]
}
```
Performance Notes
- Small Regions (< 100 chunks): Sub-10ms restore times
- Large Regions: Uses chunk streaming to maintain TPS
- Light Updates: Restore original light by default (instant light restore)
- Async Operations: Optional fully async restoration
- Chunk Unloading: Automatic cleanup prevents memory leaks
Support
For support, feature requests, or bug reports, please use the GitHub issue tracker.
Discord (recommended):
Website:
Email: pluginsupport@bruhmo.men
RegionRestore - Restore your worlds at the speed of gameplay.
评论 0
登录后参与评分
还没有评论,来抢沙发吧