Skip to content
This repository has been archived by the owner on Jan 20, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Endermanbugzjfc committed Oct 8, 2020
1 parent cfb9485 commit 6e5b41b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
| Option | Description |
| ------ | ----------- |
| `true-this-or-dream-might-quit-youtube` | The plugin power switch. **If this option is false, the plugin will disable on load.** |
| `backup-name` | The name format that the backup archive file will be use, please see the available name format tag list! |
| `smart-backup-ignorer` | Let the system to decide wether a file should be ignore or not, please see the smart ignore condition list! |
| `backup-name` | The name format that the backup archive file will be used, please see the available name format tag list! |
| `smart-backup-ignorer` | Let the system to decide whether a file should be ignored or not, please see the smart ignore condition list! |
| `file-checker-interval` | The interval in ticks between every time the file checker checks if a `backup.me` is created. |
| `ignore-disk-space` | Continue to do a server backup **even if the server disk is not having enough space.** |
## Name format tags
Expand Down Expand Up @@ -34,7 +34,7 @@
You can input certain rules to prevent the backup archiver from adding that file to the backup archive file.

**This file is using the [GitIgnore](https://git-scm.com/docs/gitignore) syntax**
***(I will replace this with another file patteren regex system since this thing requires an additional [GitIgnoreChecker](https://github.com/inmarelibero/gitignore-checker/) library and causes many issues when this plugin is running on other OS such as Windows)***
***(I will replace this with another file pattern regex system since this thing requires an additional [GitIgnoreChecker](https://github.com/inmarelibero/gitignore-checker/) library and causes many issues when this plugin is running on other OS such as Windows)***
### Example rules *(For people who have never used the GitIgnore syntax before)*
| Rules | What this rule means |
| ----- | -------------------- |
Expand All @@ -47,8 +47,8 @@ You can input certain rules to prevent the backup archiver from adding that file
| `!worlds/*` | None of all in any of the `worlds` directory |

# Start backup
Create a file name `backup.me` at the server root directory, when the file checker finds it, a server backup will be start.
Create a file name `backup.me` at the server root directory, when the file checker finds it, a server backup will be started.

**Please do not turn of the server during the backup**
**Please do not turn off the server during the backup**

If a message with the backup task used time, total amount of added files and ignored files popup. It means that the backup task is **successfully completed**, you can do whatever you want at that time. The backup archive file will be generate at the server root directory *(Where you create the `backup.me` file)*
If a message with the backup task used time, the total amount of added files and ignored files popup. It means that the backup task is **successfully completed**, you can do whatever you want at that time. The backup archive file will be generated at the server root directory *(Where you create the `backup.me` file)*

0 comments on commit 6e5b41b

Please sign in to comment.