Wrapper around a Minecraft server process, designed to automate backups.

Go to file

Jef Roosens ce3dcdd4b1 ci/woodpecker/push/build unknown status Details ci/woodpecker/push/clippy unknown status Details ci/woodpecker/push/lint unknown status Details ci/woodpecker/push/release Pipeline was successful Details chore: please clippy		2023-06-13 13:01:47 +02:00
.cargo	feat: properly backup config directory	2023-06-06 20:14:29 +02:00
.woodpecker	fix(ci): i'm dumb	2023-06-05 11:44:18 +02:00
src	chore: please clippy	2023-06-13 13:01:47 +02:00
.dockerignore	feat: solely handle single terminating signal for now	2023-06-06 20:49:00 +02:00
.gitignore	refactor: split process into own module	2023-06-03 12:20:15 +02:00
CHANGELOG.md	feat: change jvm flags order	2023-06-13 13:00:42 +02:00
Cargo.lock	chore: bump version	2023-06-13 11:40:18 +02:00
Cargo.toml	chore: bump version	2023-06-13 11:40:18 +02:00
Dockerfile	feat: add --dry flag	2023-06-13 12:53:50 +02:00
LICENSE	Initial commit	2021-09-13 12:02:06 +02:00
README.md	chore: update readme	2023-06-13 11:51:18 +02:00

README.md

Alex

Alex is a wrapper around a typical Minecraft server process. It acts as the parent process, and sits in between the user's input and the server's stdin. This allows Alex to support additional commands that execute Rust code.

Why

The primary usecase for this is backups. A common problem I've had with Minecraft backups is that they fail, because the server is writing to one of the region files as the backup is being created. Alex solves this be sending save-off and save-all to the server, before creating the tarball. Afterwards, saving is enabled again with save-on.

Features

Create safe backups as gzip-compressed tarballs using the backup command
Automatically create backups periodically
Properly configures the process (working directory, optimisation flags)
Configure everything as CLI arguments or environment variables

Installation

Alex is distributed as statically compiled binaries for Linux amd64 and arm64. These can be found here.