summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKeuin <[email protected]>2021-01-21 01:50:08 +0800
committerKeuin <[email protected]>2021-01-21 01:50:08 +0800
commitac3b5e1476dedcefb723f19bd0fdd9a22fcb16e9 (patch)
tree75d0994f3f7aa37c3d240933f0f2d179d318e597 /README.md
parent82e3986045ac7eaca6aaa290fb2283fd6c6c901a (diff)
parent7a5297de3467b1069fdf5e4a1b2aaf510ca35663 (diff)
Merge remote-tracking branch 'origin/master'
# Conflicts: # src/main/java/com/keuin/kbackupfabric/operation/backup/PrimitiveBackupMethod.java
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 27 insertions, 18 deletions
diff --git a/README.md b/README.md
index 2c34c2f..b639657 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,40 @@
# KBackup-Fabric
-A simple backup mod for fabric Minecraft server.
+A simple backup mod for **fabric** Minecraft server, which makes **normal `.zip` backup** of your world, or self-implemented **incremental backup**, with slower increasing disk usage.
-Minecraft version: 1.14.4
+一个简单的Fabric备份Mod,支持普通备份(将存档整体压缩为 `.zip` 文件,保存在 `backups` 目录下)和增量备份(按需保存到 `incremental` 目录下,并将目录树结构保存在 `backups` 目录下)
+
+Supported Minecraft version: 1.14.4, 1.15.2, 1.16.4/1.16.5
[Fabric API](https://minecraft.curseforge.com/projects/fabric/files) is required!
## 1. Commands
+(In English)
+
- **/kb** or **/kb help**: show command list
- **/kb list**: show existing backups
-- **/kb backup \[backup_name\]**: make a backup with given name or the current system time by default
-- **/kb restore \<backup_name\>**: restore to a certain backup. This command needs a confirm to execute.
+- **/kb backup \[backup_name\]**: make a backup with given name or with the current system time by default
+- **/kb incbak \[backup_name\]**: make an incremental backup which will be saved in `incremental` folder. (However, the index file will be saved in `backups` folder)
+- **/kb restore \<backup_name\>**: restore to a certain backup. This command needs a confirmation to execute.
- **/kb confirm**: confirm executing restore operation. The operation is irreversible.
- **/kb delete**: delete an existing backup.
-- **/kb prev**: Find and select the most recent backup file.
+- **/kb prev**: Find and select the most recent backup file. After executing this command, you can use `/kb restore 1` to restore to this backup.
+
+(In simplified Chinese, 简体中文版本)
+
+- **/kb** or **/kb help**: 显示命令列表
+- **/kb list**: 显示所有已有的备份
+- **/kb backup \[backup_name\]**: 以给定名字创建一个新备份,缺省的名字是“noname”
+- **/kb incbak \[backup_name\]**: 创建一个增量备份,保存在 `incremental` 目录下。 (目录树的整体结构仍然被保存在 `backups` 目录下)
+- **/kb restore \<backup_name\>**: 还原到指定的备份。该命令需要二次确认才会真正被执行
+- **/kb confirm**: 二次确认,一旦确认,等待确认的命令会立刻被执行。这个命令是不可逆的
+- **/kb delete**: 删除一个现有的备份
+- **/kb prev**: 显示并且选中最近的一个备份,执行这个命令后,可以直接使用 `/kb restore 1` 进行还原
## 2. Script for auto-restart after restoring
-Due to the nature of JVM: the Java language's running environment, there is no elegant way to restart Minecraft server in a server plugin. In order to achieve auto restarting, the outer system-based script is required, i.e the script is a batch or a shell script.
+Due to the nature of JVM: the Java language's running environment, there is no elegant way to restart Minecraft server in a server plugin. In order to auto restart after restoring, an outer system-based script is required, i.e. a batch or a shell script.
KBackup exit JVM with a special code `111` after restoring the level successfully. The startup script just check the exit code and restart Minecraft server if the code is `111`.
@@ -36,7 +52,7 @@ rem kbackup restore auto restart
pause
```
-### 2.2 Script for Linux or U\*ix using shell
+### 2.2 Script for Linux or U\*ix using shell (Not tested, I use Windows for the most time, test it on your own)
```shell
#!/bin/sh
@@ -51,14 +67,7 @@ done
## 3. To-Do List:
-- New version checker.
-- Refactor code.
-- More thorough test.
-- Implement incremental backup.
- + Restore: trace-back (recursively, then generate file dependence tree)
- - Implement unZipRecursively (unzip a .zip.inc file recursively until reaches the root (i.e. the last full backup).)
- + Backup: base-diff (select most recently backup as the base, then diff)
- - Implement zipDiff (make a new zip with the latest backup as the base, store diff-table in zip comment (A:Add, M:Modification, D:Deletion))
-- Optimize help menu. (colored command help menu)
-- Add op login hint in the next start after restoring.
-- Implement incremental backup.
+- Op login hint in the next start after restoring
+- A more friendly help menu (colored command help menu)
+- New version checker
+- Code refactor for maintainability