get5-web BETA

Status: Experimental, not supported.

This is an experimental (proof-of-concept) web panel meant to be used in conjunction with the get5 CS:GO server plugin. It provides a more convenient way of managing matches and match servers.

WARNING: YOU SHOULD NOT USE THIS. IT HAS BUGS. IT HAS NO SUPPORT. The get5 plugin itself is supported - this webpanel itself has NO support. If you want a working webpanel for get5, look elsewhere or develop your own.

How to use it:

1. Create your game servers on the "Add a server" page by giving their ip, port, and rcon password
2. Create teams on the "Create a Team" page by listing the steamids for each of the players
3. Go to the "Create a Match" page, selecting the teams, server, and rules for the match

Once you do this, the site will send an rcon command to the game server get5_loadmatch_url <webserver>/match/<matchid>/config, which will load the match config onto the gameserver automatically for you. Stats and game status will automatically be updated on the webpage.

As the match owner, you will be able to cancel the match. Additionally, on its matchpage there is a dropdown to run admin commands: add players to the teams if a ringer is needed, pause the match, load a match backup, list match backups, and run any rcon command.

Note: when using this web panel, the CS:GO game servers must be have both the core get5 plugin and the get5_apistats plugin. They are released together. This means the server must also be running the Steamworks and SMJansson extensions.

Screenshots

Requirements:

• python2.7
• MySQL (other databases will likely work, but aren't guaranteed to)
• a linux web server capable of running Flask applications (see deployment options)

Installation

Please see the installation instructions for Ubuntu 16.04 with apache2. You can use other distributions or web servers, but you will likely have to figure out how to install a python flask app yourself.

How do the game server and web panel communicate?

1. When a server is added the web server will send get5_web_available command through rcon that will check for the appropriate get5 plugins to be installed on the server
2. When a match is assigned to a server, the get5_loadmatch_url command is used through rcon to tell the websever a file to download the get5 match config from
3. When stats begin to update (map start, round end, map end, series end), the game server plugins will send HTTP requests to the web server, using a per-match API token set in the get5_web_api_key cvar when the match was assigned to the server

Other useful commands:

Autoformatting:

cd get5
autopep8 -r get5 --in-place
autopep8 -r get5 --diff # should have no output

Linting errors:

cd get5
pyflakes *.py

Testing: You must also setup a test_config.py file in the instance directory.

./test.sh

Manually running a test instance: (for development purposes)

python2.7 main.py