![Forge Version](https://img.shields.io/badge/Forge-1.20%2B-blue?logo=minecraft) ![Fabric Version](https://img.shields.io/badge/Fabric-1.20%2B-blue?logo=minecraft) ![Neoforge Version](https://img.shields.io/badge/Neoforge-1.20%2B-blue?logo=minecraft) ![License](https://img.shields.io/badge/license-MIT-blue.svg) --- ### **⚠️ Important: This is a Companion Mod!** Please note: This mod is a **companion component** for the **MineBackup desktop application** or **FolderRewind** and **cannot function independently**. You must first download and run the main application for this mod to work properly. Additionally, for proper inter-process communication, the KnotLink server must be installed on your computer. https://github.com/hxh230802/KnotLink/releases **Exception**：Linux/MacOS users do not need to install the KnotLink server. ### **⚠️ Important: Limited Dedicated Server Support** Starting from version 2.0.0, this mod supports dedicated servers in a limited way. Restore workflows such as `/mb quickrestore` and `/mb restore` remain unsupported for dedicated servers. For dedicated-server restores, please use [MineBackupPlugin](https://modrinth.com/plugin/minebackupplugin). ### **➡️ [Download the REQUIRED MineBackup Desktop Application Here](https://github.com/Leafuke/MineBackup/releases)** For Windows Users, recommend [FolderRewind](https://apps.microsoft.com/detail/9nwsdgxdqws4) with plugin [MineRewind](https://github.com/Leafuke/FolderRewind-Plugin-Minecraft/releases) rather than MineBackup.

--- ## What is This? This lightweight Forge mod serves as a bridge between the powerful **MineBackup desktop application** and **Minecraft itself**. It allows you to enjoy all the conveniences of MineBackup without ever leaving your game. ### ✨ This Mod Provides: * **Rich In-Game Commands**: Use the `/mb` command series to manage your world saves directly from the chat. You can also use the hotkey `Alt + Ctrl + S` to back up your world! * **Real-Time Backup Notifications**: Receive real-time messages from the main application in your game chat—whether a backup starts, succeeds, or fails. * **Seamless Live Backup Support**: When the main application needs to perform a "live backup" (i.e., while the game is running), this mod automatically triggers a safe, complete world save (equivalent to `/save-all`) in the background, ensuring your backup always captures the latest progress. ## 🚀 Installation Guide 1. **Download the Main Application**: Ensure you have downloaded the `MineBackup`/`FolderRewind` desktop application from the link above and that it runs correctly on your system. 2. **Download MineRewind Plugin**: **If you use FolderRewind**, it is strongly recommended to install the MineRewind plugin and create a `Minecraft Saves` type configuration instead of `Default`. You can download this plugin from [GitHub Releases](https://github.com/Leafuke/FolderRewind-Plugin-Minecraft/releases). 3. **Download and Install KnotLink Server**: For inter-process communication, install the KnotLink server on your computer. You can download it from [GitHub Releases](https://github.com/hxh230802/KnotLink/releases). 4. **Enable KnotLink Service in the Main Application**: It is enabled by default in MineBackup but disabled by default in FolderRewind. If you use **FolderRewind**, enable it manually in settings. 5. **Download This Mod**: Get the version-matched `minebackup-x.x.x.jar` file from the **[Releases](https://github.com/Leafuke/MineBackup/releases)** page or other mod distribution platforms. 6. **Install the Mod**: For single-player or LAN, place the downloaded `.jar` file in the Minecraft client's `mods` folder. For dedicated servers, install it on the server's `mods` folder; client installation is optional. 7. **Run Simultaneously**: Launch your Minecraft game or server. For the mod to function, you **must have the `MineBackup`/`FolderRewind` desktop application running in the background while playing**. ## 📖 Command Reference All commands require operator (OP) permissions for multiplayer servers. But for single-player worlds, OP is not required. On dedicated servers, backup and query commands are supported, but restore commands still require MineBackupPlugin. | Command | Parameters | Description | | :--- | :--- | :--- | | **/mb quickbackup** | `[comment]` | Performs a backup for the current world. | | **/mb quickrestore** | `[filename]` | Performs a hot restore for the current world. Single-player/LAN only. Dedicated servers should use MineBackupPlugin instead. | | **/mb save** | (none) | Manually performs a full world save in-game, equivalent to `/save-all`. | | **/mb list_configs** | (none) | Lists all your configured backup profiles and their IDs from the MineBackup desktop application. | | **/mb list_worlds** | `` | Lists all worlds under the specified configuration profile along with their indices. | | **/mb list_backups** | ` ` | Lists all available backup files for the specified world. | | **/mb backup** | ` [comment]` | Instructs the main application to create a backup for the specified world. An optional comment can be added. | | **/mb restore** | ` ` | Instructs the main application to restore the world using the specified backup file. Single-player/LAN only. Dedicated servers should use MineBackupPlugin instead. | | **/mb auto** | ` ` | Requests MineBackup to start an automatic backup task, backing up every `internal_time` minutes. | | **/mb stop** | ` ` | Requests MineBackup to stop the automatic backup task. | ### **💡 Usage Example** Let's say you want to create a backup for your server's main world: 1. **Step 1: Find the Configuration and World** * Type `/mb list_configs` to see your configuration profiles. > Chat returns: `Available Configurations: - ID: 1, Name: Survival Server` * Type `/mb list_worlds 1` to see the worlds under the "Survival Server" profile. > Chat returns: `Worlds for Config 1: - Index: 0, Name: world` 2. **Step 2: Perform the Backup** * Now you know the config ID is `1` and the world index is `0`. * Type `/mb quickbackup Preparing for Ender Dragon!` > Chat returns: `[MineBackup] Backup task for world 'world' started...` > (After a moment) > `[MineBackup] Backup successful! World 'world' saved as [Full][2025-08-11_12-33-00]world [Preparing for Ender Dragon!].7z` 3. **(If Needed) Step 3: Perform a Restore** * Execute `/mb quickrestore "[Full][2025-08-11_12-33-00]world [Preparing for Ender Dragon!].7z"`. (**Tip**: Filename can be auto-completed). * On dedicated servers, use MineBackupPlugin for restore workflows instead of the mod commands above. ## ❓ Frequently Asked Questions * **Q: When I use a command, the chat says "Command failed", "No response", or a similar error.** * **A:** Please check and ensure the `MineBackup`/`FolderRewind` desktop application is running in the background on your computer. All features of this mod rely on network communication with the main application. * **Q: Can this mod be used by itself?** * **A:** No. It is a "bridge" and cannot do anything without the main application. ## 📄 License This project is licensed under the [MIT License](https://github.com/Leafuke/MineBackup/blob/main/LICENSE). For details, please visit the main project repository.