PluralBackupJava

插件

· 作者 PluralTeam

PluralBackup 是 Minecraft Java Edition 服务器的自动热备份插件

0 本站下载 0 关注 更新于 4 个月前

最新 1.0.4 · 26.2 · Bukkit / Paper

一键开服(送7天)

特性

  • 计划自动备份:可配置的备份间隔,默认 60 分钟

  • 基于时间的备份模式:在指定时区的特定时间触发备份(支持 24/12 小时格式)

  • 手动触发备份:通过命令立即执行备份

  • 启动时备份:服务器启动时自动执行备份(可选)

  • 热备份:异步执行,不阻塞主线程

  • 世界保存控制:备份前保存世界数据,备份期间暂停自动保存以防止数据不一致

  • 压缩备份:支持将备份文件压缩为 zip 格式以节省磁盘空间

  • 备份文件管理:自动清理旧备份,保留指定数量的最新备份(手动上传至 GitHub 后也会进行清理)

  • 多云存储上传:支持本地目录、FTP/FTPS、WebDAV、百度网盘、123 网盘

  • GitHub 备份:通过 GitHub Release API 上传/下载备份,支持自动创建私有仓库

  • 告警通知:备份失败时通过电子邮件、飞书机器人、钉钉机器人发送告警

  • 备份还原:从指定的备份中恢复世界数据(将重新加载世界)

  • 热重载配置:无需重启服务器即可重新加载配置文件

  • 状态查询:查看插件状态与调度器信息

安装

  1. 下载最新的 PluralBackupJava-1.0.0.jar
  2. 将 jar 文件放入服务器的 plugins/ 目录中
  3. 启动服务器,插件将在 plugins/PluralBackup/config.yml 自动生成默认配置文件
  4. 根据需要编辑配置文件
  5. 执行 /backup reload 或重启服务器以应用更改

命令

所有命令都需要 pluralbackup.admin 权限(默认:OP)。

命令 说明
/backup now 立即执行备份
/backup list 列出所有备份
/backup restore <备份名称> 恢复指定的备份
/backup clean 清理旧备份
/backup reload 重新加载配置文件
/backup status 查看插件状态
/backup github-list 列出 GitHub 上的备份版本

| /backup github-download <版本> | 从 GitHub 下载指定版本 |

| /backup github-upload | 备份服务器并上传至 GitHub |

别名:/pbackup、/pluralbackup

配置

配置文件位于 plugins/PluralBackup/config.yml:

# 基本备份设置
backup:
  auto-backup: true              # 启用自动备份(间隔模式)
  interval-minutes: 60           # 备份间隔(分钟,仅适用于间隔模式)
  backup-on-start: false         # 在服务器启动时执行备份
  broadcast-message: true        # 广播备份消息
  # 计划备份(基于时间的触发,独立于间隔模式,可与间隔模式同时启用)
  schedule:
    enabled: false               # 启用基于时间的模式
    timezone: "Asia/Shanghai"    # 触发时区,例如 Asia/Shanghai、America/New_York、Europe/London
    use-24-hour-format: true     # 使用 24 小时制(false 表示使用带有上午/下午的 12 小时制)
    times:                       # 触发时间列表
      - "00:00"                  # 24 小时制示例:["00:00", "06:00", "12:00", "18:00"]
      - "12:00"                  # 12 小时制示例:["12:00 AM", "06:00 AM", "12:00 PM", "06:00 PM"]

backup-dir: "backups"            # 备份目录(相对于插件数据文件夹)
max-backups: 10                  # 最大备份数量(0 = 无限制)
compress: true                   # 压缩为 zip 格式

exclude-dirs:                    # 排除的目录(相对于服务器根目录)
  - "plugins/PluralBackup/backups"

# 备份行为
save-world-before-backup: true   # 在备份前保存所有世界
pause-autosave-during-backup: true  # 在备份期间暂停自动保存
file-copy-retry-count: 3         # 文件复制重试次数
file-copy-retry-delay-ms: 500    # 重试延迟(毫秒)

# 云上传
cloud:
  enabled: false
  type: "local"                  # local / ftp / webdav / baidu / pan123
  local:
    path: "cloud-backups"
  ftp:
    host: "127.0.0.1"
    port: 21
    username: "ftpuser"
    password: "ftppass"
    remote-dir: "/backups"
    use-ssl: false
  webdav:
    url: "https://dav.example.com/backups"
    username: "user"
    password: "pass"
  # 百度网盘 (https://pan.baidu.com/union/console)
  baidu:
    app-id: ""
    app-secret: ""
    app-folder: ""               # 产品名称,文件存储在 /我的应用数据/{app-folder}/ 下
    access-token: ""             # 留空以自动获取并缓存
  # 123云盘 (https://www.123pan.cn/developer)
  pan123:
    client-id: ""
    client-secret: ""
    access-token: ""             # 留空以自动获取并缓存
    parent-folder-id: 0          # 目标文件夹 ID,0 表示根目录

警报通知

notification: enabled: false # 启用备份失败通知

邮件通知

email: enabled: false smtp-host: "" # 例如 smtp.qq.com smtp-port: 465 use-ssl: true username: "" # 发送者登录账号 password: "" # 授权码(QQ 邮箱需要授权码) from: "" # 发件人邮箱 to: "" # 收件人邮箱 subject: "PluralBackup 备份警报"

飞书机器人

feishu: enabled: false webhook: "" # 自定义机器人 Webhook secret: "" # 签名密钥(如果不使用签名则留空)

钉钉机器人

dingtalk: enabled: false webhook: "" # 自定义机器人 Webhook secret: "" # 签名密钥(如果不使用签名则留空)

GitHub 备份

github: enabled: false token: "your-github-token" # 具有仓库权限的 PAT owner: "your-username" repo: "PluralGamneBackup" auto-create-repo: true # 如果不存在则自动创建私有仓库

消息设置

backup-start-message: "§e[备份] §b服务器正在执行自动备份..." backup-done-message: "§e[备份] §a备份完成!耗时:{time}s" backup-fail-message: "§e[备份] §c备份失败:{error}"


## GitHub 备份说明

1. 创建具有 `repo` 权限的 GitHub 个人访问令牌,建议不设过期时间
2. 在配置文件中配置 `token`、`owner`、`repo`
3. 启用 `github.enabled: true`
4. 如果仓库不存在则自动创建私有仓库(需设置 `auto-create-repo: true`)
5. 空仓库会自动初始化(写入 README.md),否则 Release 创建将失败
6. 备份文件以 Release Assets 形式上传,单个文件大小限制为 2GB
7. GitHub 定时备份与本地备份共享 `interval-minutes` 设置
8. 所有网络操作(上传/下载)均异步执行,不阻塞主线程
9. 手动执行 `/backup github-upload` 将自动清理本地旧备份(受 `max-backups` 限制)

## 双模式定时备份

插件支持两种独立的触发模式,可同时启用:

**1. 间隔模式** (`backup.auto-backup: true` + `backup.interval-minutes: 60`)
- 每隔 N 分钟执行一次备份
- 适用于高频备份场景

**2. 基于时间的模式** (`backup.schedule.enabled: true`)
- 在指定时区的特定时间执行备份
- 支持自定义时区(例如 `Asia/Shanghai`、`America/New_York`、`Europe/London`)
- 支持 24 小时制格式(`HH:mm`,例如 `00:00`、`12:00`、`18:30`)
- 支持 12 小时制格式(`hh:mm a`,例如 `12:00 AM`、`06:00 PM`)
- 可配置多个触发时间

两种模式可同时启用且互不冲突。示例:间隔模式每小时备份一次,基于时间的模式在每天 00:00 和 12:00 额外增加备份。

## 权限

| 权限 | 默认值 | 描述 |
|------------|---------|-------------|
| `pluralbackup.admin` | OP | 使用所有备份管理命令 |

## 构建

```bash
mvn clean package

生成的 jar 文件位于 target/PluralBackupJava-1.0.0.jar。

许可证

Copyright © PluralTeam

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源