diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..479a325 --- /dev/null +++ b/readme.txt @@ -0,0 +1,27 @@ + +C CGI Xonotic DeFrag +A CGI script to display data related to Race CTS leaderboards of Xonotic servers. + +This program uses an sqlite3 database file created from ~/.xonotic/data/data/server.db. +It is not responsible for the creation of the database itself. + +Environments and Contexts: + MinGW/GCC 4.7.1 - compiled + SQLite3 - database functionality + Xonotic 0.8.1autobuild - game and build + +Web Server Queries + (none) + Query file: + queries/mranks.sql + Requests the maplist of the server and related data. + + map= + Query file: + queries/mleaderboard-ojoin.sql + Requests the leaderboard of the map. + + player= + Query file: + queries/rplayers.sql + Requests a player's ranks for all maps leaderboards s/he is present on.