https://github.com/leafuke/minebackup
A simple but useful GUI program to backup and restore your MC saves.
https://github.com/leafuke/minebackup
automation backup linux macos minecraft tools windows
Last synced: about 1 month ago
JSON representation
A simple but useful GUI program to backup and restore your MC saves.
- Host: GitHub
- URL: https://github.com/leafuke/minebackup
- Owner: Leafuke
- License: gpl-3.0
- Created: 2023-10-05T12:33:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-02-21T08:04:35.000Z (about 1 month ago)
- Last Synced: 2026-02-21T15:07:57.961Z (about 1 month ago)
- Topics: automation, backup, linux, macos, minecraft, tools, windows
- Language: C++
- Homepage: https://leafuke.github.io/MineBackup-Web/
- Size: 9.14 MB
- Stars: 85
- Watchers: 3
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Notice: notice
Awesome Lists containing this project
README
# MineBackup β The Ultimate Backup Companion for Your Minecraft Worlds ποΈπΎ
[](README_zh.md)
[](https://github.com/Leafuke/MineBackup/releases)
[](https://github.com/Leafuke/MineBackup/issues)
> **Back up with confidence Β· Restore in seconds Β· Compress intelligently**
> Keep your Minecraft worlds safe β and yes, you can back up any folder on your PC, too.
---
## β¨ Why MineBackup?
- π― **Plug-and-Play** β A single executable. Download, double-click, done.
- π₯ **Clean, Fast GUI** β Powered by ImGui. Simple layout, snappy response.
- πΎ **Secure Backups** β One click to safeguard your Minecraft saves.
- π **Quick Restores** β Roll back to any previous state from a `.7z` file or local backup.
- π¦ **High Compression** β Built-in 7-Zip core saves disk space.
- π§ **Smart Mode** β Git-like incremental backups to save time and storage.
- π **Custom Paths** β Store backups wherever you want.
- π **Multi-language** β Currently supports English and Chinese β more are welcome!
- π» **Multi-platform** β Currently supports Windows, Linux and MacOS.
π‘ **Pro tip:** It works on any folder, not just Minecraft worlds.
---
## π Getting Started
### 1οΈβ£ Download & Run
1. Go to the [latest release](https://github.com/Leafuke/MineBackup/releases).
2. Download the single Windows executable.
3. Double-click to run β **no installation required**.
### 2οΈβ£ Basic Actions - Basic
| Feature | How to Use |
|--------------|------------|
| Back up a world | Select a world β click **Backup** |
| Restore a world | Select a world β click **Restore** (from `.7z` or local directory) |
| Change backup location | Open **Settings** β choose your path |
| Switch language | Settings β Language |
### 3οΈβ£ Power Features
- **Hotkey Backup** β Press **Alt+Ctrl+S** in-game to trigger a live backup.
- **Exit Detection** β Enable *DetectOnExit* to back up automatically when Minecraft closes.
- **KnotLink Integration** β Let MineBackup talk to mods or other tools to trigger βsave before backup.β An example mod is [here](https://modrinth.com/mod/minebackup).
---
## π Feature Highlights
### π₯ Hotkey Backups
- Hit **Alt + Ctrl + S** while playing:
Detects the currently active world β broadcasts a save request β runs a hot backup in the background.
### π Auto Exit Backups
- With *DetectOnExit* enabled, MineBackup checks every 10 seconds for changes to `level.dat`.
- When it sees the file go from βin useβ to βreleased,β it automatically performs a hot backup.
### π‘ KnotLink Messaging
MineBackup can send and receive simple text events to coordinate with other apps or mods. View [MineBackup](https://modrinth.com/mod/minebackup) as an example mod for detail.
- **Supported Commands:**
```
BACKUP \ \ \[comment]
RESTORE \
LIST\_WORLDS \
LIST\_CONFIGS
SET\_CONFIG \
````
*key*: `backup_mode` / `hot_backup`
*value*: `1/2/3` or `0/1`
> π See [Developer & Advanced User Guide](#-developer--advanced-user-guide) for full protocol details.
---
## βοΈ Installation & Build
**Requirements:**
- Windows/Linux/MacOS
- C++20 compiler
- ImGui library linked
- 7-Zip executable
**Build:**
```bash
# Clone the repo
git clone https://github.com/Leafuke/MineBackup.git
cd MineBackup
# Make sure the ImGui source is included
````
---
## π€ Contributing & Support
* **Report bugs / request features:** [GitHub Issues](https://github.com/Leafuke/MineBackup/issues)
* **Help translate:** Edit [`i18n.h`](MineBackup/i18n.cpp) and submit a pull request.
* **Improve docs:** PRs welcome β examples, screenshots, and tips appreciated.
---
## π Developer & Advanced User Guide
### KnotLink Quick Reference
| Command | Description |
| ------------- | ---------------------------------------- |
| BACKUP | Immediately back up a given config/world |
| RESTORE | Restore a given config |
| LIST_WORLDS | List all worlds under a config |
| LIST_CONFIGS | List all configs |
**APPID:** `0x00000020`
**socket ID:** `0x00000010`
**signal ID:** `0x00000020`
---
## π Project References
* [**7-Zip**](https://github.com/ip7z/7zip) β Compression core (7z.exe)
* [**ImGui**](https://github.com/ocornut/imgui) β GUI framework
* [**stb**](https://github.com/nothings/stb) β Image loading
* [**KnotLink**](https://github.com/hxh230802/KnotLink) β Lightweight inter-process messaging
* [**json**](https://github.com/nlohmann/json) β Metadata read & write
* [**Font-Awesome**](https://github.com/FortAwesome/Font-Awesome) - Icons
---
## π Note
The next generation of MineBackup has been realesed as [FolderRewind](https://github.com/Leafuke/FolderRewind). It features better versatility and a modern UI. Features are being actively developed there.
---
**MineBackup** β Peace of mind for your Minecraft worlds.
β If you find it useful, please give it a star!