chore: update readme
Some checks failed
ci/woodpecker/push/release unknown status
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/clippy Pipeline was successful
ci/woodpecker/push/build Pipeline was successful

This commit is contained in:
Jef Roosens 2023-06-13 11:51:18 +02:00
parent 45d736d1bb
commit acb3cfd8e6
Signed by: Jef Roosens
GPG key ID: B75D4F293C7052DB

View file

@ -1,3 +1,26 @@
# mc-wrapper
# Alex
A wrapper around a standard Minecraft server, written in Rust.
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](https://git.rustybever.be/Chewing_Bever/alex/packages).