Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 6.02 KB

readme.md

File metadata and controls

130 lines (90 loc) · 6.02 KB
Raw

CSGO Tournament Manager

Status

Because of the CS2 announcement the development is paused until CS2 is released. If you want to try the current (a bit unstable) version, check the development branch, which is a complete rework of the project.

This software is still more in development than it is production ready

History:

Currently, it is being updated and rewritten for the 'airLAN23' which will take place in around 'Pfingsten' 2023 (27.05.2023 - 29.05.2023).

The software has been developed for the airlan21 (25.06.2021). A small csgo tournament organized for team-building by robo4you.at. It was also used at the airlan23 winter (07.01.2023).

What does this software do?

It manages a number of get5 servers for small to medium lan parties. E.g. the webinterface (and the telegram bot) lets you define new matches by selecting players and creating teams. A new get5 server will then be started in a docker container and the match config file will be transferred and loaded to the csgo server. It also displays some basic statistics about the servers.

Create matches in the webinterface

create_match

Watch the status of matches/ stop them

create_match

How to use this software

1. Create csgo docker container

  • Go to the folder get5_image and run the build_image.sh script.
  • This will download the csgo server and automatically install get5. (this step may take some time)

2. Create Teams and GSLT file

  • Edit the teams.json file to include all your teams and players. This file will be mounted in the dockerfile.
  • Edit the gslt.json file and include all your GSLT tokens in a list like: ["TOKEN1", "TOKEN2"]. If you plan on only using the servers in a LAN setting, you can simply create the file and leave the list empty (like: []) and then the server manager will start the CSGO servers without a GSLT Token. (More information about GSLT Tokens: https://developer.valvesoftware.com/wiki/Counter-Strike:_Global_Offensive_Dedicated_Servers)
  • Create a postgres.env file with the following content: 
    POSTGRES_USER=postgres
POSTGRES_PASSWORD=pass
POSTGRES_DB=postgres

3. Telegram BOT

  • Create .env file in the folder telegram_bot/.env
  • Fill it with the following content: 
    BOT_TOKEN=your_token_here
CHAT_IDS="chat_id_1,chat_id_2..."
  • The first line is the telegram bot token of your bot. The second line specifies who has access to the bot and can send messages/ commands to it. If you are not sure what your chat_id is, then leave the field empty for the time being and run the bot only with the bot token. Then add your bot and type /help in the chat. Look at the log output of the software, and you will see your chat_id printed there.
  • Start group phase matchmaking using the command /startMatchmaking

4. Start the software

  • Then start the server like: docker-compose up --build
  • Goto http://127.0.0.1 and create matches.
  • The match will be started in a docker container and be visible in the /status page.

5. Connecting to the server

(Note connecting with 127.0.0.1:port does not work, you need your PCs local IP (like 192.168.x.x or 10.x.x.x etc.) or that of a VPN network)

  • Connect to the server, on the ip shown in the webinterface/ on telegram
  • Webinterface: Public Webinterface containing stats is available at: /public/stats
  • Admin webinterface is available at: /auth/login (login there and get redirected to the admin webinterface)

ELO

Currently, an ELO rating system for teams is being implemented.

Multiple Game Hosts (still in development)

Set the following environment variables in the slave docker-compose file for the csgo_manager:

  • Change the following ENV Variables on slave game hosts:
  • MASTER=1: Set this ENV var to 0 on all game hosts except one.
  • MASTER_IP="127.0.0.1": The IP of the master server (the one that runs the database etc.)
  • DB_HOST="db": IP/ Hostname of the database host (this should be set to the same as MASTER_IP on slaves)

Set this on the slaves and the master:

  • EXTERNAL_IP="127.0.0.1": The external IP of the game host (the one that is used to connect to the csgo servers).

Connect to the master on port :8080 and login to adminer. The username and database is "postgres", for the password see the env variables below "Securing the API".

Securing the API

  • ACCESS_SECRET_KEY="this_is_not_a_secret": Should be a random generated secret like: openssl rand -hex 32
  • ACCESS_TOKEN_EXPIRE_MINUTES=60 * 24 * 2: How long the access tokens are valid (in minutes) (Can be left at default value)
  • API_PASSWORD="admin": The password for the API user
  • ADMIN_PASSWORD="admin": The password for the admin user in the webinterface (login at: /auth/login)
  • HTTP_PROTOCOL="http": The protocol used to connect to the api
  • RCON_PASSWORD="pass": The password for the rcon connections to the csgo servers.
  • GOTV_PASSWORD="pass": The password for the GOTV connections to the csgo servers.
  • DB_PASSWORD="pass": The password for the database connection. (Important: This must be set to the same value as the ENV variable POSTGRES_PASSWORD is set for postgres.)

If the ENV variables here are changed, you will also need to set them in the slave instances.

Note: Most of these security measures only make sense if you also use https. So putting the software behind a haproxy etc. will be nessasary.

Major TOODS

  • refactor backend structure, split functionality into different services, e.g. stats collecting, match management etc.
  • clearer seperation between master and slaves, maybe only management instance is the real "master" and all other servers only host games and provide nothing else
  • improve matchamking algorithm and document it better/ at all
  • improve api security

Banned Players

SteamID Reason
STEAM_0:1:148684053 Cheating during airlan21 (wallhack)
STEAM_0:1:159656029 Cheating during airlan21 (wallhack)