Skip to content
This repository has been archived by the owner on Oct 19, 2021. It is now read-only.

Latest commit

 

History

History
100 lines (58 loc) · 6.16 KB

README.md

File metadata and controls

100 lines (58 loc) · 6.16 KB
Raw

This web panel is no longer maintaned, and you shouldn't use it! For more information, please check out this issue

get5-web

Build Status Build Status GitHub Downloads

Status: NOT Supported - End of Life Jan. 2020

As of January 1st, 2020, this application will no longer be supported with any updates. Issues will be created to help assist setup and point out any bugs. If someone would like to take over, please make a fork and make some PRs to fix any issues. If you would even like, merge them back here with a link to your fork in the README. Thank you everyone for finding this web panel, and I hope you still find use for this old technology. Some new development is coming down the pipe elsewhere, which I hope will help other developers make their own implementations of get5-web.

This is a 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. This webpanel is intended for competitive 5v5 leagues and scrims, and nothing more.

This fork of get5 introduces a few new features that are used within get5 already, but were not originally ported over to the experimental web-panel. I've tried to make the web panel a little bit more secure (storing passwords, etc), and more handy for people to organize matches (Seasons and Leaderboards). Right now it's considered complete as it fits my needs and small-scale application. If you have any feature suggestions, please create an issue. It's extremely unlikely I'll put any more work into it, but pull requests are always welcome with features, provided they've been tested and pass CI!

WARNING: THIS BUILD OF THE WEB-PANEL USES MODIFIED GET5-APISTATS MATERIAL. I DO NOT TAKE RESPONSIBILITY FOR ANY DATA LOSS, MISUSE, ETC. THAT THIS WEBAPP MAY INCUR.

IF YOU HAVE ANY ISSUES WITH THE WEBPANEL OR THE API_STATS PLUGIN, PLEASE REPORT IT HERE.

How to use it:

  1. Download the new get5_apistats.smx from the releases page.

  2. Create your game servers on the "Add a server" page by giving their ip, port, and rcon password

  3. Create teams on the "Create a Team" page by listing the steamids for each of the players

  4. Go to the "Create a Match" page, selecting the teams, server, and rules for the match

  5. Optional - Create a season with a given date range to keep track for a subset of matches.

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. This means the server must also be running the Steamworks and SMJansson extensions, as well as System2 (for automated demo uploads, if you so choose). If you are using the public webpanel, please do not do FTP uploads, as they will not link properly on the web-panel itself, but will still upload to your personal FTP server.

Screenshots

Match Creation Page

Match Stats Page

Teams Page

Team Creation Page

Season Creation Page

Season View Page

Requirements:

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. Raspberry Pis do work, but require a few other packages to be installed for apache.

How do the game server and web panel communicate?

  1. When a server is added the web server will send get5_web_avaliable 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:

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