README.md

Regularbackup

A regular backup plugin based on MCDReforged

Here is a MCDR plugin collection repository

MCDReforged/
├─ plugins/
│  ├─ Regularbackup.py
│  ├─ 7z.exe
│  ├─ my_plugin1.py
│  └─ ...
│
├─ rb_temp/
│  ├─ Backup_file/
|  |  ├─ time1.zip
|  |  ├─ time2.zip
│  |  └─ ...
│  ├─ temp1/
│  └─ temp2/
│
└─ MCDReforged.py

Environment

Python version needs to be Python 3.8+ & MCDReforged 0.8.2-alpha.Tested on Windows 10 18362 x64 + Python 3.7.4 + MCDRegorged 0.9.2-alpha.

Usage

1. Download the latest MCDR release in the release page. Of course you can just clone this repository to get the latest build (might be unstable but with latest features)
2. Copy Regularbackup.py to mcdr_root/plugins
3. Enter !!MCDR plugin load Regularbackup
4. Enjoy

Commands

!!rb Show Help Messages

!!rb make Make a backup immediatly

!!rb start <time> Make a backup every <time> minutes

!!rb status Show the status of Regular Backup

!!rb stop Stop auto backup

!!rb list <page> List all backups

!!rb clean Clean old backups

Compatibility

If you are using Non-Windows OS

• You need to replace 7z.exe with a suitable copy of 7zip depending on your operating system OR set the enable_compression to False to disable compression feature.
• You need to set the enable_auto_clean to False to prevent backup loss.

Constant explain

• Please refer to QuickbackupM and MCDR-AutoCleaner

• serverName Your server name.It's also the prefix of each zip files

• compression_level Custom 7zip compression level.The larger the number, the smaller the zipfile and the longer the time. (Default: 2)

• daily_delete & weekly_delete Custom how long to clean backups. (Default: 1 & 2)

• enable_compression Whether to turn on compression (Default: True)

• enable_auto_clean Whether to turn on auto clean backups (Default: True)