From 0c8ea2eae265faa19443c966261fd3a582dc7caf Mon Sep 17 00:00:00 2001 From: NullBite Date: Fri, 16 Jun 2023 23:48:51 -0400 Subject: [PATCH] Add README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7358b2 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# mcserver +dead simple wrapper script to manage multiple minecraft server instances in +tmux, in a way that makes it extremely easy to use with systemd. + +## instructions +1. install systemd unit in /etc/systemd/system, change `User` option to preferred user +2. create minecraft server instances in `~/.local/share/mcserver/instances` + - you can also symlink server directories from elsewhere on the system + - use `instance/` as a starting point. you need, at minimum, a startup + script that executes the server jar, the server jar itself and a `vars` + file +3. `systemctl enable --now mcserver@instancename`