Update README.md
parent
4fa30024cf
commit
1e60c05477
52
README.md
52
README.md
|
@ -1,43 +1,35 @@
|
|||
# Textile Backup
|
||||
>Finally, a backup mod for fabric!
|
||||
[](https://www.curseforge.com/minecraft/mc-mods/textile-backup)
|
||||
[](https://modrinth.com/mod/textile_backup)
|
||||
|
||||
[中文/Chinese](https://github.com/Szum123321/textile_backup/blob/2.x/README_zh-CN.md)
|
||||
## What is it?
|
||||
Textile Backup porvides a way to automatically make a backup of your world, zip it and even bring it back later, replacing your old world, all without leaving the game.
|
||||
|
||||
[
|
||||
](https://www.curseforge.com/minecraft/mc-mods/textile-backup)
|
||||
------------
|
||||
### List of features
|
||||
- Multithreaded compression: backups are made much faster than with other mods.
|
||||
- Multiple compression formats: performace can be tuned to your preference
|
||||
- It's super easy to bring back an old verion of your world (Requires server restart)
|
||||
- Built-in management features: you can whitelist/blacklist players' access to txb commands
|
||||
- Automatic deletion of old files (Age-, Number- and Size- based)
|
||||
- Highly configurable: [Wiki](https://github.com/Szum123321/textile_backup/wiki/Configuration)
|
||||
- Fully server-sided: all features are available even if it's only peresent on the server
|
||||
|
||||
Small, configurable, fully server-side backup mod for Fabric
|
||||
[**Installation Guide**](https://github.com/Szum123321/textile_backup/wiki/Installation)
|
||||
[**Usage Guide**](https://github.com/Szum123321/textile_backup/wiki/Usage)
|
||||
|
||||
Commands look like that: `/backup <operation> [args]`
|
||||
------------
|
||||
|
||||
Available operations are:
|
||||
|
||||
* start - just starts backup. You can add comment* to file by just typing it after command. For example: `/backup start FabricIsGreat`
|
||||
* restore - restores backup. Note that the current world will be backuped, and you can add comment to it. `/backup restore <creation date> [comment]`
|
||||
* killR - terminate current restoration.
|
||||
* list - lists all avaliable backups.
|
||||
* cleanup - forces cleanup procedure (deletes old backups according to config)
|
||||
* delete - delets given file, usage the same as restore
|
||||
* whitelist - here you can add, remove and list player that are allowed to run any operation within this mod despite not having high enough permission level*
|
||||
* blacklist - here you can add, remove and list player that are not allowed to run any operation within this mod despite having high enough permission level*
|
||||
|
||||
All of the above can only be done by server admins(permission level 4 - configurable*) or player on a single player.
|
||||
This mod requires both the Fabric API and Cloth Config to run.
|
||||
|
||||
Feel free to use this mod in your modpack or on a server!
|
||||
|
||||
### Important
|
||||
------------
|
||||
|
||||
* Time format defaultly used by this mod is: dd.MM.yyyy_HH-mm-ss although it is configurable*.
|
||||
* Since 2.2.0 TxB depends on **Cloth config**
|
||||
### Contact:
|
||||
|
||||
\* - feature available since 1.1.0
|
||||
|
||||
If you have any suggestions or found a problem please report it on [Github](https://github.com/Szum123321/textile_backup).
|
||||
|
||||
And here's a link to my [discord server](https://discord.gg/ktasEy4)
|
||||
|
||||
For copyright info see: [Copyright Notice](/Copyright_Notice)
|
||||
If you need any help then you can join the [Discord](https://discord.gg/ktasEy4) server
|
||||
In case on an issue please report [Here](https://github.com/Szum123321/textile_backup/issues)
|
||||
|
||||
If you'd like to support me:
|
||||
[](https://en.cryptobadges.io/donate/bc1qwnqrdv5rs36tkfgxmnkw5f7qx4nhsncy5kj69s)
|
||||
[](https://en.cryptobadges.io/donate/0xF196c12b0A013d91015c541E63A87BA636851871)
|
||||
[](https://en.cryptobadges.io/donate/bc1qwnqrdv5rs36tkfgxmnkw5f7qx4nhsncy5kj69s)[](https://en.cryptobadges.io/donate/0xF196c12b0A013d91015c541E63A87BA636851871)
|
||||
|
|
Loading…
Reference in New Issue