3 NitRPG is a Role Playing Game that takes place on [GitHub](https://github.com/).
5 In NitRPG, GitHub users are represented by players that battle on repo for
10 * Auto-update with GitHub hooks
11 * Display repo statistics
12 * Display players statsitics
13 * Repo actions are rewarded by nitcoins
14 * Players can unlock achievements
25 ### Configuring the GitHub hook
27 NitRPG needs you to add a new GitHub hook on your repo to keep the game
28 `listener` up-to-date automatically.
32 * **Payload URL**: URL and port to the listener (ex: `http://yourdomain.com:8080`)
33 * **Content type**: `application/json`
34 * **Wich events**: `Send me everything`
36 Be sure to set the hook as `Active` in the GitHub admin panel.
38 ### Starting the listener
40 The `listener` program is used to listen to GitHub hooks and update game data.
41 It should alwaysd be up if you want your game to be kept up-to-date.
45 ./listener <host> <port>
47 The arguments `host` and `port` must correspond to what you entered in your
50 ### Starting the web server
52 The `web` program act as a [nitcorn](http://nitlanguage.org/doc/stdlib/module_nitcorn__nitcorn.html) webserver that display the game results live.
56 ./web <host> <port> <root>
58 The arguments `host` and `port` must correspond to what you entered in your
60 The `root` argument is used to specify the path from the domain url to the
63 For example, if NitRPG is installed in `yourdomain.com/nitrpg`:
65 ./web localhost 3000 "/nitrpg"
67 Leave it empty if NitRPG is installed at the root of the domain:
69 ./web localhost 3000 ""
71 The webserver can then be accessed at `http://yourdomain.com:3000/nitrpg/`.
75 NitRPG stills under heavy development.
76 Incomming features contain (but are not limited to):
78 * Periodized stats (weekly, monthly, yearly, overall)
79 * Display graphs with stats
81 * Shop: exchange Nitcoins against glorifying items
83 You can suggest new achievements or ideas in the
84 [NitRPG RoadMap Issue](https://github.com/privat/nit/issues/1161).