Quake 3 / Quake Live match processing app
Project description
Quake Stats
Quake 3 logs / Quake Live events processing project.
Allows to retrieve, process, analyze, store and present Quake matches.
The project doesn't aim to give global stats like qlstats it's rather meant to store statistics from some server group (server domain). The origins of Quake Stats come from a group of players who occasionally play together and want to keep track of their matches... and to have fun from some custom made medals (badges) :)
Overview
Supported features:
- processing Quake 3 logs (log parsing, at the moment OSP mod only)
- processing Quake Live event streams (zmq listen, needs some work)
- translating (to some extent) Quake 3 logs into Quake Live events
- analysing matches
- storing matches in Database backend (Mongo DB)
- presenting match results through a web application
Supported mods and game modes
Unfortunately only OSP FFA from Quake 3 is well tested as it was the main use case
mods
- - OSP
- - Quake Live - most of event processing is implemented
- - vanilla Q3 not supported due to missing ServerTime info
modes
- - FFA
- - CA (partially tested)
- - TDM
- - CTF
Custom medals
Are described here resources.js
Examples
The stats are presented with fancy charts, custom medals, etc. See the examples below.
Total badges/medals board
Total kills & deaths
Single match Kill Death Ratio, Worst Enemy, Score over Time chart
Requirements
- Decent version of Python 2 or 3
- Instance of Mongo DB (pointed by
settings.py
) - Modern web browser (requires css grid-layout)
How to setup
In order to setup the application you need to have python 2 or 3 (virtualenv recommended) and an instance of mongo DB.
Installation
Install from pip package
pip install quakestats
Install from source code
Is also needed install quakestats
package (in virtualenv if you are using it). To do that you could install it directly
pip install -r requirements.txt
python setup.py install
Configuration file
The application is configured by setting QUAKESTATS_SETTINGS
environment variable to path to configuration file.
See example settings.py
Verify if everything is properly set up
Quake Stats provide a simple CLI with a command to verify an environment
quakestats status
Example output:
(venv) [user@pc quakestats]$ quakestats status
app -> version: 0.9.61
settings -> env var: /opt/quakestats/settings.py
settings -> RAW_DATA_DIR: /opt/quakestats/data
db -> ping: {'ok': 1.0}
webapp -> loadable: Quakestats webapp is loadable
Run Quake Stats web app
You can setup Quake Stats web app with any websever you want (as long as it supports python, e.g. mod wsgi, uwsgi). This documentation covers only running in twisted webserver
Run in twistd (example)
You can launch Quake Stats web application using twistd
webserver. Just make sure to install twisted framework first.
Also make sure to use some recent version of twisted (tested with 18.7.0 installed by pip).
FLASK_APP="quakestats.web"; QUAKESTATS_SETTINGS=`pwd`/settings.py; twistd web --wsgi quakestats.web.app
User/Admin guide
Setup admin user
Admin user is used by web application to access some additional administrative operations. For now it's only setting map sizes. Just to have a list of recently used maps and their sizes. Nothing more at the moment.
# you need to run the command in proper python environment
# use "quakestats status" to check your environment
quakestats set-admin-pwd <yourpassword>
Uploading Quake 3 log file
In order to process some data you need to send your match log file to web api endpoint /api/v2/upload
.
You need an ADMIN_TOKEN
set in configuration.
curl -X POST --form file=@/path/to/your/games.log --form token=adminsecrettoken host:port/api/v2/upload
All log files with extracted matches are stored in directory determined by RAW_DATA_DIR
config entry
Rebuilding database
You can rebuild your database using files stored in RAW_DATA_DIR
with simple web api call or CLI.
curl -X POST host:port/api/v2/admin/rebuild --form token=adminsecrettoken
# you need to run the command in proper python environment
# use "quakestats status" to check your environment
quakestats rebuild-db
If you implement some new Medals or any other backend related feature this API call will clear previous data stored in DB and process all matches from data directory once again.
Merging player results
Unfortunately the only way to distinguish players in Quake 3 servers is to use player nickname. When player changes his nickname between matches he will be treated as new unique player. In such cases admin can merge results of two specific players. Use with caution as it will rewrite history of all matches stored in database.
curl -X POST host:port/api/v2/admin/players/merge --form token=admintoken --form source_player_id=297f6272f79d4918c4efe098 --form target_player_id=df55e5cd4582d6f14cd20746
It will merge all results from player with id 297f6272f79d4918c4efe098
into player with id df55e5cd4582d6f14cd20746
. To find out how player ID is build see the development section.
Importing preprocessed match log
Preprocessed match logs stored in RAW_DATA_DIR
can be imported using admin match import API.
This can be particularly useful when e.g. debugging some bugs on dev infra.
curl -X POST --form file=@bugmatch.log --form token=admintoken host:port/api/v2/admin/match/import
Development
Tech stack
Python, Flask, MongoDB, d3.js, riot.js, zmq
Building blocks
There are several 'responsibility bound' components
Dataprovider
Groups logic related to gathering data (logs, events), processing and analysis.
How does it work with Quake 3 Players
Quake 3 players don't have unique ID's so it's hard to distinguish players between matches. In order to overcome this problem each player has player_id
assigned during match analysis. The ID is constructed as hash of SERVER_DOMAIN
and player nickname as a result it's consistent between matches as long as player keeps his nickname and there is no nickname clash. Perhaps there is some better way? Server side auth?
Datasource
Groups logic related to storage backend and storage related operations
Web
Web application related components
- api - web API used by frontend and to retrieve Quake 3 logs
- views - typical flask views
Data flow
# Data gathering
Quake Live Data (events) -> QLMatchFeeder >-------|
|----> Data Preprocessor (FullMatchReport)
Quake 3 Data (log) -> Q3MatchFeeder -> Q3toQL >---|
# Data procesing
Data Preprocessor (FullMatchReport) -> Data Analyzer (AnalysisResult)
# Data storage
Data Analyzer (AnalysisResult) -> StorageApi -> StorageBackend
Web data flow
Stats webapp ----| -> Web API -> StorageApi -> StorageBackend
Extending
How to add new medal
- see SpecialScores class - for special scores
- see Badger class - for badges calculation
- see JS resources - to add new medal image
Running tests
make test
Assets
Medals, icons, etc. Some of the assets are missing it would be nice to find some free ones or draw them ;)
TODO
- Add support for listening to Quake Live event publisher, minor work needed
How to release new version
bumpversion <major|minor|patch> --commit --tag
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for quakestats-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9b81b4ce30082664e639367d9384b7f651598eb9ee304dcd5387fe470797259 |
|
MD5 | 89fc18bc79b101ee76acbf55f917291e |
|
BLAKE2b-256 | 4fd7b584f268a8c43eeb458393ed23a631960fcba8bcc2e48f363840a15ed355 |