scuti/xdfcgi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Website CGI (or page generator) to display Race CTS leaderboards of a Xonotic server.
47 Commits 4 Branches 0 Tags 149 KiB
C 57.7%
Python 35.9%
HTML 3.4%
Makefile 2.3%
CSS 0.7%
221ef0da61
Go to file
scuti 221ef0da61 ignore text files
2024-10-30 03:16:35 -07:00
doc Limited line width to 80 characters 2017-09-14 13:43:40 -07:00
include merged branch 'speed-records', squashed 2024-10-18 21:21:02 -07:00
output merge staticgen, squashed 2024-10-12 11:15:11 -07:00
queries merged branch 'speed-records', squashed 2024-10-18 21:21:02 -07:00
scripts added arg to change log folder 2024-10-30 03:15:13 -07:00
src corrected typo (of velocity) 2024-10-27 18:12:59 -07:00
templates merged branch 'speed-records', squashed 2024-10-18 21:21:02 -07:00
.gitignore ignore text files 2024-10-30 03:16:35 -07:00
LICENSE Added license file 2017-09-14 13:27:29 -07:00
Makefile merged branch 'speed-records', squashed 2024-10-18 21:21:02 -07:00
README.md merged branch 'speed-records', squashed 2024-10-18 21:21:02 -07:00

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 static page generator.

make cgi makes a CGI program.

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) Queries

  • (none)

    • file: queries/mranks.sql
    • Requests the map list of the server, the best times scored per map and by which player.

  • ?fastest-players

    • file: queries/fastest-players.sql
    • Requests the map list of the server, the highest velocities attained per map and by which player.

  • ?map=[map name]

    • file: queries/mleaderboard-ojoin.sql
    • Requests the leaderboard of the map.

  • ?player=[clientid]

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

queries/fastest-player-of-map.sql is used exclusively by the python script scripts/allmaps.py.

Usage: Static Page Generation

python scripts/allmaps.py

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.