X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fxonstat.git;a=blobdiff_plain;f=README.md;h=02e50b0fdc7d8af0fc9c3e34ebec7128e08c8aa6;hp=4bf59d785909df7d92cd70d4afb17bf9cf0f4aa9;hb=HEAD;hpb=17788af16d2cf59bb10e0d077a893441b3c74166 diff --git a/README.md b/README.md index 4bf59d7..02e50b0 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,18 @@ This is **XonStat**, the application in front of [xonstatdb][xonstatdb]. ---- -To start, first run the following from the root directory to set up dependencies: +To start, create a virtualenv and install dependencies: - python setup.py develop + virtualenv env + source env/bin/activate + +From within the directory you've cloned the repo, install the dependencies: + + pip install -r requirements.txt + +Next, install the application itself: + + pip install -e . Next you'll want to set up [xonstatdb][xonstatdb]. This is maintained as a separate project here: @@ -18,15 +27,15 @@ The other setting to change is "session.secret," which is used to keep your web To start the server run the following from the root directory. I recommend running this within a GNU screen session: - paster serve development.ini #(or production.ini if you've configured that settings file instead) + pserve --reload development.ini #(or production.ini if you've configured that settings file instead) -To get a Xonotic server configured to use this server, change the CVAR `g_playerstats_uri` to point to the correct host, port, and URL path. By default this is: +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: http://localhost:6543/stats/submit ...so in the server console (or in your config) you can put: - set g_playerstats_uri http://localhost:6543/stats/submit + set g_playerstats_gamereport_uri http://localhost:6543/stats/submit 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.