Compute the number of real players during parsing.
[xonotic/xonstat.git] / README.md
1 This is **XonStat**, the application in front of [xonstatdb][xonstatdb].  
2 [XonStat][xonstat] handles the submission of statistical information from the open source first person shooter [Xonotic][xonotic].
3
4 ----
5
6 To start, first run the following from the root directory to set up dependencies:
7
8     python setup.py develop
9
10 Next you'll want to set up [xonstatdb][xonstatdb]. This is maintained as a separate project here:
11
12     https://github.com/antzucaro/xonstatdb
13
14 Next you'll want to open up development.ini and change a few things for added security.
15 Chief among these is the "sqlalchemy.url" setting, which contains your username and password for the database.
16 Change that match the new password you gave xonstat during the installation of xonstatdb.
17 The other setting to change is "session.secret," which is used to keep your web session (cookies and such) secure.
18
19 To start the server run the following from the root directory. I recommend running this within a GNU screen session:
20
21     pserve --reload development.ini #(or production.ini if you've configured that settings file instead)
22
23 To get a Xonotic server configured to use this server, change the CVAR `g_playerstats_gamereport_uri` to point to the correct host, port, and URL path. By default this is:
24
25     http://localhost:6543/stats/submit
26
27 ...so in the server console (or in your config) you can put:
28
29     set g_playerstats_gamereport_uri http://localhost:6543/stats/submit
30
31 If you have any questions or issues please open up a bug report here, or - better yet ! - fork it and send me a pull request.
32
33 [xonstatdb]: https://github.com/antzucaro/xonstatdb
34 [xonstat]: http://stats.xonotic.org/
35 [xonotic]: http://www.xonotic.org/
36
37 ----
38
39 Project is licensed GPLv2+.