MineBackup-Plugin
MineBackup-Plugin is a Spigot plugin based on Minecraft 1.21. As a complementary component to MineBackup/FolderRewind, it communicates with the main program through the KnotLink protocol, enabling cross-end data synchronization and signal broadcasting. It allows remote control of backup, restoration, automatic backup, and other functions.
For the mod version, see MineBackup-Mod. Compared to the mod version, the plugin version has undergone many optimizations for server-side use.
Features
- KnotLink Protocol Support: Subscribes to broadcast signals from the MineBackup main program via a long-lived TCP connection (default port
6372), enabling low-latency cross-end communication. - Fully Compatible with 1.21.x: Developed based on the latest Spigot API 1.21, supporting Java 21.
- Lightweight Architecture: Focuses on signal subscription and command forwarding, consuming minimal server resources.
Requirements
- Minecraft Version: 1.21.x
- Server Software: Spigot / Paper and its forks
- Java Version: Java 21 or higher
- Dependencies: Requires the MineBackup/FolderRewind+MineRewind main program to be running (provides the KnotLink signal source).
Installation and Usage
- Download the latest
.jarfile from the Releases page. - Place the downloaded
.jarfile into your server'spluginsfolder. - Start or restart your server.
- Ensure the MineBackup main program is running and that the KnotLink Server is installed on your computer. Specifically, Linux/macOS users do not need to install the separate KnotLink Server.
Commands and Permissions
| Command | Parameters | Description |
|---|---|---|
| /mb save | (none) | Manually performs a full world save in-game, equivalent to /save-all. |
| /mb list_configs | (none) | Lists all configuration profiles you have set up in the MineBackup main program along with their IDs. |
| /mb list_worlds | <config_id> |
Lists all worlds under the specified configuration along with their index numbers. |
| /mb list_backups | <config_id> <world_index> |
Lists all available backup files for the specified world. |
| /mb backup | <config_id> <world_index> [comment] |
Commands the main program to create a backup for the specified world. An optional comment can be attached. |
| /mb restore | <config_id> <world_index> <filename> |
Commands the main program to restore the world using the specified backup file. If you intend to restore the current world, you must use /mb quickrestore. |
| /mb auto | <config_id> <world_index> <interval_time> |
Requests MineBackup to perform automatic backup tasks at the specified interval (in minutes). |
| /mb stop | <config_id> <world_index> |
Requests MineBackup to stop the automatic backup task. |
| /mb quicksave | [comment] |
Performs a backup for the current world. |
| /mb quickrestore | [filename] |
Performs a hot restore for the current world. If no filename is provided, the latest backup file is automatically selected. |
| /mb confirm | (none) | Confirms the execution of a hot restore. |
| /mb abort | (none) | Cancels an impending hot restore. |
| /mb reload | (none) | Reloads the configuration. |
Please note that the specific execution behavior differs between the plugin and the mod. Pay close attention during use.
