Swooping in to backup your worlds!
Go to file
Joey Hines 5a403b4b64 Updated readme 2020-11-03 21:54:15 -06:00
src Added the ability to restore chunks from a backup 2020-11-03 21:46:16 -06:00
.drone.yml Added .drone.yml 2020-10-24 13:45:53 -05:00
.gitignore Initial Commit 2020-06-06 14:41:42 -05:00
Cargo.lock Added the ability to restore chunks from a backup 2020-11-03 21:46:16 -06:00
Cargo.toml Added the ability to restore chunks from a backup 2020-11-03 21:46:16 -06:00
LICENSE Added LICENSE 2020-06-06 14:42:30 -05:00
README.md Updated readme 2020-11-03 21:54:15 -06:00

README.md

Albatross

Back up what you care about in your Minecraft worlds.

Albatross backs up player files and region files within a certain configurable radius. It can also send Discord webhooks. Backups are compressed and stored as tar.gz archives.

Help

albatross 0.3.0
Backup your Minecraft Server!

USAGE:
    albatross --config-path <config-path> <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --config-path <config-path>    Path to the Albatross config [env: ALBATROSS_CONFIG=]

SUBCOMMANDS:
    backup     Backup a server
    export     Export a backup as a single player world
    help       Prints this message or the help of the given subcommand(s)
    restore    Restore certain chunks from a backup

Examples

Running a backup:

albatorss -c test.toml backup

Exporting a backup to a single player world:

albatorss -c test.toml export backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz

Restoring a range of chunks (from -2,-2 to 2,2):

albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz -2 -2 2 2

Config

[backup]
# Minecraft sever directory
minecraft_dir = "/home/mc/server"
# Directory to place backups
output_dir = "/home/mc/backups"
# Number of backups to keep
backups_to_keep = 10
# Discord Webhook
discord_webhook = "https://discordapp.com/api/webhooks/"

# World config options
[[world_config]]
# world name
world_name = "world"
# world save radius (in blocks)
save_radius = 8000