README_en.md

中文 | English

Better_Backup

Archived! Use PrimeBackup plz

Warning

Better Backup is currently in an experimental phase. It is strongly recommended that you do not use it in a production environment and do backup important data.
Before reporting a problem, please make sure you are using the latest version.

An MCDR plugin for efficient backup and restore, with less disk usage and no duplicate files.

Important

Version >=2.0.0 does not compatible with old JSON backup data from previous versions.
Version >=2.1.0 does not compatible with old HASH data from previous versions.
Please migrate, or clear all data in better_backupbefore updating.

Features

• Avoid duplicate files, save 20% ~ 90% backup space compared to QuickBackupM.
  Significantly outperforms QuickBackupM for large backups and HHD.
• Built-in timed backups
• Supports zstd compression, which saves extra 50% backup space without affecting archive speed.
• xxHash for hash values, saving 20% ~ 70% of computing time.
• Supports automatic deletion of old backups and retaining the specified number of backups.
• Easily export full backups

---

The backup archive will be stored in the better_backup folder with the following directory format:

mcd_root/
    better_backup/
        cache/ # Backup files
            00/
                ...
            0a/
            0b/
                ...

        export_backup/
            ...

        overwrite/
            ...
        
        storage.db # database

Configuration

The configuration file is config/better_backup.json. It will be automatically generated the first time it's run, with the following default values (comments are not really supported):

{
    "size_display": true,
    "turn_off_auto_save": true,
    "ignored_files": [
        "session.lock"
    ],
    "ignored_folders": [],
    "ignored_extensions": [
        ".lock"
    ],
    "world_names": [
        "world"
    ],
    "save_command": {
        "save-off": "save-off",
        "save-all flush": "save-all flush",
        "save-on": "save-on"
    },
    "saved_output": [
        "Saved the game",
        "Saved the world"
    ],
    "backup_data_path": "./better_backup",
    "server_path": "./server",
    "overwrite_backup_folder": "overwrite",
    "backup_compress_level": 3, // 1~22
    "export_backup_folder": "./export_backup",
    "export_backup_format": "tar_gz", // plain, tar, tar_gz, tar_xz
    "export_backup_compress_level": 1,
    "auto_remove": true,
    "backup_count_limit": 20,
    "minimum_permission_level": {
        "make": 1,
        "restore": 2,
        "remove": 2,
        "confirm": 1,
        "abort": 1,
        "reload": 2,
        "list": 0,
        "reset": 2,
        "timer": 2,
        "export": 4
    },
    "timer_enabled": true,
    "timer_interval": 5.0
}