get5-web - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #android #rust #deep-learning #linux #docker #macos #kubernetes #vue #openai

get5-web

(★ 101)

An unsupported, proof-of-concept webpanel for servers using the get5 CS:GO server plugin. Please don't use it.

File Explorer

Download Latest Version (.zip)

- - layout.html
  - macros.html
  - match.html
  - match_backup.html
  - match_create.html
  - matches.html
  - metrics.html
  - server_create.html
  - servers.html
  - team.html
  - team_create.html
  - teams.html
  - user.html
- __init__.py
- api.py
- api_test.py
- countries.py
- countries_test.py
- get5_test.py
- logos.py
- manage.py
- match.py
- match_test.py
- models.py
- server.py
- server_test.py
- steamid.py
- steamid_test.py
- team.py
- team_test.py
- util.py
- util_test.py
- .gitignore
- prod_config.py.default
- test_config.py.default
- .gitignore
- - 2610b84c0bf5_.py
  - 48c5a5bb98cf_.py
  - 54c17052c8f4_.py
  - 5b607892c512_.py
  - 8bc3fc909d1a_.py
  - b28b5677726e_.py
  - c18a8e939c8e_.py
  - cca93c217647_.py
  - d1a12773d8f3_.py
  - d84462b5a7a5_.py
  - e0e6530b2ce4_.py
- alembic.ini
- env.py
- README
- script.py.mako
- create_match.png
- match_stats.png
- team_edit.png
- teams.png
.flake8
.gitignore
.travis.yml
INSTALL.md
LICENSE
main.py
manager.py
README.md
requirements.txt
test.sh

# Installation Guide

1. Get the code

git clone https://github.com/splewis/get5-web

Downloads the entire project code from GitHub to your computer.

cd get5-web

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python main.py

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

get5-web BETA
===========================

[![Build Status](https://travis-ci.org/splewis/get5-web.svg?branch=master)](https://travis-ci.org/splewis/get5-web)

**Status: Experimental, not supported.**

This is an **experimental** (proof-of-concept) web panel meant to be used in conjunction with the [get5](https://github.com/splewis/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](https://github.com/splewis/get5/releases) together. This means the server must also be running the [Steamworks](https://forums.alliedmods.net/showthread.php?t=229556) and [SMJansson](https://forums.alliedmods.net/showthread.php?t=184604) extensions.

## Screenshots

![Match Creation Page](https://raw.githubusercontent.com/splewis/get5-web/master/screenshots/create_match.png)

![Match Stats Page](https://raw.githubusercontent.com/splewis/get5-web/master/screenshots/match_stats.png)

![Teams Page](https://raw.githubusercontent.com/splewis/get5-web/master/screenshots/teams.png)

![Team Creation Page](https://raw.githubusercontent.com/splewis/get5-web/master/screenshots/team_edit.png)

## 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](http://flask.pocoo.org/docs/0.11/deploying/))

## Installation

Please see the [installation instructions](INSTALL.md) 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
```