# CaCl2Backup<\/p>\n
[\u4e2d\u6587](README.md) | English<\/p>\n
A comprehensive Minecraft server backup mod designed for Fabric.<\/p>\n
## Features<\/p>\n
– **Scheduled Backups** – Configurable automatic backups at set intervals after server startup
\n– **Multi-threaded Compression** – Parallel compression using multiple threads for significantly faster backups
\n– **Automatic Cleanup** – Hourly automatic cleanup of old backups with both count and age limits
\n– **Full Restore** – Complete world save restoration from backups
\n– **Label System** – Add labels to backups for easy identification (special characters auto-replaced with underscores)
\n– **Index Operations** – Quickly select backups by index number without typing full filenames
\n– **Real-time Status** – View backup status, configuration, and backup list
\n– **Hot Reload Config** – Reload configuration without restarting the server
\n– **Auto-Restart Restore** – Optionally auto-restart the server after restoring a backup<\/p>\n
## Requirements<\/p>\n
– Minecraft 26.1.2
\n– Fabric Loader 0.15.0+
\n– Fabric API
\n– Java 25+<\/p>\n
## Installation<\/p>\n
1. Ensure Fabric Loader and Fabric API are installed
\n2. Place the mod JAR file into your server’s `mods` folder
\n3. Start the server – the mod will automatically generate the configuration file<\/p>\n
## Command Reference<\/p>\n
All commands require OP privileges and use the `\/backup` prefix.<\/p>\n
### Basic Commands<\/p>\n
| Command | Description | Example |
\n|———|————-|———|
\n| `\/backup create [label]` | Create a manual backup (optional label) | `\/backup create before_update` |
\n| `\/backup list` | List all available backups (shows index numbers) | `\/backup list` |
\n| `\/backup status` | Show current configuration and status | `\/backup status` |
\n| `\/backup reload` | Reload configuration file | `\/backup reload` |
\n| `\/backup cleanup` | Manually clean up old backups | `\/backup cleanup` |<\/p>\n
### Restore & Delete<\/p>\n
| Command | Description | Example | **Tip:** Use `\/backup list` to view backup index numbers, then use the index directly.<\/p>\n ### Configuration Commands<\/p>\n | Command | Description | Example | ## Configuration File<\/p>\n Configuration file location: `config\/cacl2backup.json`<\/p>\n “`json ### Configuration Options<\/p>\n | Option | Type | Default | Description | ## Usage Guide<\/p>\n ### Creating Backups<\/p>\n **Manual backup (recommended before important operations):** **View backup list:** ### Restoring World<\/p>\n **Warning: Restore operation will overwrite the current world save!**<\/p>\n 1. View backup list to get index number: 2. Restore using index: 3. Behavior depends on configuration: 4. World is automatically replaced on next server startup<\/p>\n **Configure auto-restart behavior:** ### Deleting Backups<\/p>\n Delete using index: ## Backup Triggers<\/p>\n | Trigger | Description | **Note:** Backups are NOT created when shutting down the server.<\/p>\n ## Backup File Naming<\/p>\n “` Examples: **Label naming rules:** ## Performance<\/p>\n ### Multi-threaded Compression<\/p>\n The mod uses parallel compression to significantly speed up backups for large worlds:<\/p>\n | World Size | 1 Thread | 4 Threads | 8 Threads | ### Compression Level Comparison<\/p>\n | Level | Ratio | Speed | Use Case | ## Best Practices<\/p>\n 1. **Regular Backup Checks** 2. **Reasonable Retention Policy** 3. **Manual Backup Before Important Operations** 4. **Off-site Backups** ## Troubleshooting<\/p>\n ### Backup Failed<\/p>\n **Problem:** `Backup failed: World directory not found`<\/p>\n **Solution:** Confirm the server world folder is named `world`.<\/p>\n ### World Issues After Restore<\/p>\n **Problem:** Incomplete world data after restore<\/p>\n **Solution:** ### Permission Issues<\/p>\n **Problem:** Cannot execute commands<\/p>\n **Solution:** Ensure the player has been set as OP (use `\/op player_name`).<\/p>\n ## Development Info<\/p>\n – **Author:** CaCl2 ## Changelog<\/p>\n ### 1.0.2 ### 1.0.1 ### 1.0.0 A simple backup mod, supports multi-threads.<\/p>\n","protected":false},"featured_media":36312,"template":"","meta":{"_minecraft_slug":"cacl2backup","_minecraft_project_id":"DxsfSgfS","_minecraft_author":"RealCaCl2","_minecraft_license":"MIT","_minecraft_downloads":30,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"cacl2backup.zip","_minecraft_size_bytes":49819,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T13:57:47.779300Z","_minecraft_date_created":"2026-05-03T00:00:36.206168Z","_minecraft_date_modified":"2026-04-28T10:20:57.953526Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/cacl2backup","_minecraft_icon_attachment_id":36312,"_minecraft_imported_at":"2026-06-01T18:00:34+00:00","_minecraft_import_hash":"0413a97e640b1590689be3b260d695b5","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97],"mod_loader":[99],"minecraft_version":[163],"class_list":["post-36311","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_loader-fabric","minecraft_version-26-1-2"],"yoast_head":"\n
\n|———|————-|———|
\n| `\/backup restore
\n| `\/backup delete
\n|———|————-|———|
\n| `\/backup config` | Show all configuration options | `\/backup config` |
\n| `\/backup config interval
\n| `\/backup config maxbackups
\n| `\/backup config maxage
\n| `\/backup config autobackup
\n| `\/backup config autocleanup
\n| `\/backup config threads
\n| `\/backup config level <1-9>` | Set compression level | `\/backup config level 6` |
\n| `\/backup config autorestart
\n| `\/backup config restartdelay
\n| `\/backup config restartdelay
\n| `\/backup config restartmessage
\n| `\/backup config broadcastrestart
\n{
\n “backupIntervalMinutes”: 30,
\n “maxBackups”: 10,
\n “compressionThreads”: 8,
\n “compressionLevel”: 6,
\n “autoBackupEnabled”: true,
\n “autoCleanupEnabled”: true,
\n “maxBackupAgeDays”: 7,
\n “backupFolderName”: “backups”,
\n “broadcastBackupMessages”: true,
\n “saveOnBackup”: true,
\n “autoRestartAfterRestore”: false,
\n “restartDelaySeconds”: 60,
\n “restoreRestartMessage”: “Server will restart in {seconds} seconds to complete restore…”,
\n “broadcastRestoreMessage”: true
\n}
\n“`<\/p>\n
\n|——–|——|———|————-|
\n| `backupIntervalMinutes` | int | 30 | Auto-backup interval in minutes (minimum: 1) |
\n| `maxBackups` | int | 10 | Maximum number of backups to keep |
\n| `compressionThreads` | int | CPU cores | Number of compression threads |
\n| `compressionLevel` | int | 6 | Compression level (1-9), 1 is fastest with lowest ratio, 9 is slowest with highest ratio |
\n| `autoBackupEnabled` | boolean | true | Enable automatic backups |
\n| `autoCleanupEnabled` | boolean | true | Enable automatic cleanup of old backups |
\n| `maxBackupAgeDays` | int | 7 | Maximum backup age in days |
\n| `backupFolderName` | String | “backups” | Backup folder name |
\n| `broadcastBackupMessages` | boolean | true | Broadcast backup messages to all players |
\n| `saveOnBackup` | boolean | true | Save world before backup |
\n| `autoRestartAfterRestore` | boolean | false | Auto-restart server after restore |
\n| `restartDelaySeconds` | int | 60 | Auto-restart delay in seconds (minimum: 10) |
\n| `restoreRestartMessage` | String | “Server will restart in {seconds} seconds…” | Restart message template, {seconds} is replaced with delay |
\n| `broadcastRestoreMessage` | boolean | true | Broadcast restart message |<\/p>\n
\n“`
\n\/backup create before_major_update
\n“`<\/p>\n
\n“`
\n\/backup list
\n“`
\nExample output:
\n“`
\n[CaCl2Backup] Available backups (5):
\n1. 2024-02-20 10:30:00 [before_update] – 125.3 MB
\n2. 2024-02-19 22:00:00 [auto] – 124.8 MB
\n3. 2024-02-19 10:00:00 – 123.5 MB
\n…
\n“`<\/p>\n
\n “`
\n \/backup list
\n “`<\/p>\n
\n “`
\n \/backup restore 1
\n “`<\/p>\n
\n – **autoRestartAfterRestore=false (default)**: Manually stop the server to complete restore
\n – **autoRestartAfterRestore=true**: Mod auto-restarts server after specified delay<\/p>\n
\n“`
\n\/backup config autorestart on # Enable auto-restart
\n\/backup config restartdelay 60 # Set delay to 60 seconds
\n\/backup config restartmessage “Server will restart in {seconds} seconds…” # Custom message
\n\/backup config broadcastrestart on # Enable broadcast
\n“`<\/p>\n
\n“`
\n\/backup delete 2
\n“`<\/p>\n
\n|———|————-|
\n| Scheduled Auto-Backup | Automatically executes at configured interval after server startup |
\n| Manual Command | Execute `\/backup create [label]` |<\/p>\n
\nbackup_YYYY-MM-DD_HH-mm-ss.zip # No label
\nbackup_YYYY-MM-DD_HH-mm-ss_label.zip # With label
\n“`<\/p>\n
\n– `backup_2024-02-20_10-30-00.zip`
\n– `backup_2024-02-20_10-30-00_before_update.zip`<\/p>\n
\n– Allowed: letters `a-zA-Z`, digits `0-9`, underscore `_`, hyphen `-`
\n– Other characters (spaces, special symbols, etc.) are auto-replaced with underscore `_`<\/p>\n
\n|————|———-|———–|———–|
\n| 500 MB | ~45s | ~15s | ~10s |
\n| 2 GB | ~3min | ~1min | ~40s |
\n| 5 GB | ~8min | ~2.5min | ~1.5min |<\/p>\n
\n|——-|——-|——-|———-|
\n| 1-3 | ~40% | Fastest | Frequent backups, SSD storage |
\n| 4-6 | ~50% | Balanced | Daily use (recommended) |
\n| 7-9 | ~55% | Slower | Limited storage space |<\/p>\n
\n – Run `\/backup list` regularly to confirm backups are created
\n – Test restore process periodically to ensure backups are usable<\/p>\n
\n – Both `maxBackups` and `maxBackupAgeDays` apply simultaneously
\n – Recommended: Keep at least 3-5 valid backups<\/p>\n
\n – Before mod updates
\n – Before major building projects
\n – Before server version upgrades<\/p>\n
\n – Periodically copy backup folder to another location
\n – Consider cloud storage sync for backups<\/p>\n
\n1. Ensure server is restarted after restore completes
\n2. Check if backup file is complete (normal file size)
\n3. Try using a different backup file<\/p>\n
\n– **Version:** 1.0.2
\n– **License:** MIT
\n– **Minecraft Version:** 26.1.2
\n– **Fabric API Version:** 0.146.1+<\/p>\n
\n– Refactored restore flow: Removed `\/backup restarter` command, auto-restart integrated into `\/backup restore`
\n– New config options: `autoRestartAfterRestore`, `restartDelaySeconds`, `restoreRestartMessage`, `broadcastRestoreMessage`
\n– New config commands: `\/backup config autorestart`, `\/backup config restartdelay`, `\/backup config restartmessage`, `\/backup config broadcastrestart`<\/p>\n
\n– Updated to Minecraft 26.1.2
\n– Added GitHub Release workflow
\n– Java version requirement raised to 25+<\/p>\n
\n– Initial release
\n– Multi-threaded compression
\n– Scheduled auto-backups
\n– Automatic cleanup of old backups
\n– Full restore functionality
\n– Label system
\n– Index-based quick selection
\n– Hot reload configuration<\/p>\n","protected":false},"excerpt":{"rendered":"