New Readme
This commit is contained in:
parent
3827d5fa22
commit
365b7a910a
30
README.md
Normal file
30
README.md
Normal file
@ -0,0 +1,30 @@
|
||||
C CGI Xonotic DeFrag
|
||||
-----------------
|
||||
A CGI program written in C to display data related to Race CTS leaderboards of Xonotic servers.
|
||||
|
||||
## Requirements
|
||||
* SQLite3
|
||||
|
||||
## Web Server Queries
|
||||
* `(none)`
|
||||
- Query file: `queries/mranks.sql`
|
||||
- Requests the maplist 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.
|
||||
|
||||
## Game Versions Used Under:
|
||||
* Xonotic 0.8.1
|
||||
* Xonotic 0.8.2
|
||||
|
||||
## Compilers
|
||||
* MinGW, GCC 4.7.1
|
||||
__________________
|
||||
This program uses an sqlite3 database file created from `~/.xonotic/data/data/server.db`.
|
||||
|
||||
The database may be built using [xonotic-py-sqlite3-defrag2db](https://git.teknik.io/antares/xonotic-py-sqlite3-defrag2db).
|
27
readme.txt
27
readme.txt
@ -1,27 +0,0 @@
|
||||
|
||||
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=<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.
|
Loading…
Reference in New Issue
Block a user