Website CGI (or page generator) to display Race CTS leaderboards of a Xonotic server.

scuti c596d53b17 minor readme edit 2 mesiacov pred
doc 0a8611065b Limited line width to 80 characters 7 rokov pred
include f18aec4ff5 Revised repository organization 7 rokov pred
output f17c6a8f68 merge staticgen, squashed 2 mesiacov pred
queries 45052ac853 integrating old import script 2 mesiacov pred
scripts 01ab63d9fd removed __init__.py 2 mesiacov pred
src f17c6a8f68 merge staticgen, squashed 2 mesiacov pred
templates f17c6a8f68 merge staticgen, squashed 2 mesiacov pred
.gitignore 511d47e4a2 Added ignore file. 7 rokov pred
LICENSE dad86bc0f2 Added license file 7 rokov pred
Makefile f17c6a8f68 merge staticgen, squashed 2 mesiacov pred
README.md c596d53b17 minor readme edit 2 mesiacov pred

README.md

xdfcgi

A common gateway inferface (CGI) program written in C to display Race CTS leaderboards of Xonotic servers. It can also be a static page generator.

Requirements

sqlite-devel python3 python-sqlite

The first is only needed for compilation of the C program. The latter two are only for the auxiliary script allmaps.py.

Compiling

make makes a CGI program.

make staticgen makes a static page generator.

Usage: Import data from Xonotic

This program uses an sqlite3 database file created from ~/.xonotic/data/data/server.db (text).

sqlite3 my-new.db
sqlite > .read schema.sql

python scripts/import-from-xon.py my-new.db ~/.xonotic/data/data/server.db

Usage: CGI Query Strings

The program queries the database db/cts.db (./src/dbquery.c, function static bool executequery)

  • (none)

    • Query file: queries/mranks.sql
    • Requests the map list of the server and related data.
  • ?map=[map name]

    • Query file: queries/mleaderboard-ojoin.sql
    • Requests the leaderboard of the map.
  • ?player=[clientid]

    • Query file: queries/rplayers.sql
    • Requests a player's ranks for all maps leaderboards s/he is present on.

Usage: Static Page Generation

python scripts/allmaps.py

The CGI program is still invoked in static generation. The files allmaps.py, output/leaderboard.css, overview.html, map.html produce the output.

Before executing allmaps.py, copy and modify the templates.

cp templates/overview.html .
cp templates/map.html .

allmaps.py outputs an html file for all distinct maps in the database. The leaderboards for each map (equivalent to ?map=[map name]) are in output/maps/.

Game Versions Used Under:

  • Xonotic 0.8.1
  • Xonotic 0.8.2

Compilers

  • gcc (GCC) 10.2.1
  • MinGW, GCC 4.7.1

The script scripts/import-from-xon.py is based on https://git.teknik.io/antares/xonotic-py-sqlite3-defrag2db by Antares.