From 02ce50e1143959290d8c3fe46b2a66e0d97a89ee Mon Sep 17 00:00:00 2001 From: DeathByDenim Date: Thu, 10 Feb 2022 20:36:07 -0500 Subject: [PATCH] Added README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..041f8f7 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Game server + +This is a collection of scripts to deploy game servers on Debian 11. All game +servers are wrapped in SystemD units and can be controlled by systemctl. + +It also comes with a web front end which features the games hosted as well as +their respective download link. It also displays server stats and has an admin +panel for game servers that have interactive shells. + +The following games are deployed: + +* Bzflag +* Hedgewars +* Mindustry +* OpenHV +* OpenSpades +* SuperTuxKart +* Teeworlds +* Unvanquished +* Xonotic + +It is based on https://git.libregaming.org/c/onFOSS-LAN-Serverconfiguration + +## Installation + +The main script is `deploy.sh`. You only need to give if your domain name +``` +DOMAINNAME=play.jarno.ca ./deploy.sh +``` +This will download all the game servers, install them, configure them, and start them up. It also retrieves a certificate for Let's Encrypt for the web interface.