This repository has been archived on 2023-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
gameserver/README.md

88 lines
3.4 KiB
Markdown
Raw Permalink Normal View History

2023-10-22 22:02:25 +02:00
## This repository is no longer being updated
This code is now part of the onFOSS organization. Refer to https://git.libregaming.org/onFOSS/Gameserver for the up-to-date version of the game server.
2022-02-11 02:36:07 +01:00
# 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:
2023-04-21 02:10:43 +02:00
* Armagetron Advanced
2022-02-11 02:36:07 +01:00
* Bzflag
* Hedgewars
2022-02-13 19:30:31 +01:00
* Lix
2022-02-11 02:36:07 +01:00
* Mindustry
2023-04-21 02:10:43 +02:00
* Minetest (Blockbomber mod)
* Odamex
2022-02-11 02:36:07 +01:00
* OpenHV
* OpenSpades
2022-07-31 16:03:02 +02:00
* OpenSoldat
2023-04-21 02:10:43 +02:00
* Shattered Paradise
2022-02-11 02:36:07 +01:00
* SuperTuxKart
* Super Tux Party
* Teeworlds (optionally as DDrace)
2023-04-21 02:10:43 +02:00
* UFO: Alien Invasion
2022-02-11 02:36:07 +01:00
* Unvanquished
* Xonotic (optionally as Battle Royale)
2022-02-11 02:36:07 +01:00
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 and your own name.
2022-02-11 02:36:07 +01:00
```
2022-07-31 16:03:02 +02:00
DOMAINNAME=play.jarno.ca HOSTEDBYNAME=DeathByDenim ./deploy.sh
2022-02-11 02:36:07 +01:00
```
2022-07-31 16:03:02 +02:00
This will download all the game servers, install them, configure them, and start them up. It should take less than an hour for all game servers to be up and running.
2023-05-05 01:01:19 +02:00
If you don't have a domainname, just use the IP address.
It also retrieves a certificate for Let's Encrypt for the web interface. If you don't want the certificate, you can also specify `NOSSL=1`. This will also convert all internal links to http, meaning that if you add a certificate later things will break due to modern browser not allowing mixed http/https content.
2022-02-15 01:19:09 +01:00
There is also support for generating just the website without the game server which is useful if you want to host the website somewhere else while your main server is down.
```
DOMAINNAME=play.jarno.ca HOSTEDBYNAME=DeathByDenim ./pack_web_offline.sh
```
The webpage will display "OFFLINE" and not attempt to show the server stats.
The password for the admin panel as well as for game servers that support admin password is stored in `/etc/gameserverpassword`. The username for the admin panel is just `onfoss`.
2022-07-31 16:07:19 +02:00
2023-04-20 23:02:21 +02:00
## Website
The website is generated using Jekyll which uses a config.yml that is generated by the deploy script. Additionally, there is a YAML file called events.yml in the _data directory where events are stored. The formatting is:
```
- date: 2022-12-17T14:00:00UTC
intro: "onFOSS-LAN hosted by DeathByDenim"
games:
- time: "14:00"
title: "Get together"
- time: "14:30"
title: "Doom (ODAMEX) XMAS mod"
- time: "15:15"
title: "Teeworlds"
tournament: true
- time: "16:00"
title: "OpenSpades"
- time: "17:00"
title: "Break"
- time: "18:00"
title: "Lix"
- time: "18:30"
title: "Free Play!"
extras: ["Shattered Paradise"]
```
Each game must have a title and it optionally can have a time as well. The optional field extras lists games that were played as part of a bigger category, in this example the free play section.
Finally, you can also specify tournament which will make this game appear in the tournament page.
2022-07-31 16:07:19 +02:00
## Repository
The main version of this git repository is on [git.libregaming.org](https://git.libregaming.org/DeathByDenim/gameserver). There is a mirror on [Github](https://github.com/DeathByDenim/gameserver)