Added README

This commit is contained in:
DeathByDenim 2022-02-10 20:36:07 -05:00
parent 9171133fc6
commit 02ce50e114
Signed by: DeathByDenim
GPG Key ID: 4A475283D925365B
1 changed files with 30 additions and 0 deletions

30
README.md Normal file
View File

@ -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.