Create README.md

This commit is contained in:
Jack Bond-Preston 2016-07-21 15:01:36 +01:00 committed by GitHub
parent a69636788f
commit 3135ddddd6

55
README.md Normal file
View File

@ -0,0 +1,55 @@
trivia-bot
==========
A bot which provides a Trivia game for [Discord](https://discordapp.com/).
### Adding to a server
You can either self-host trivia-bot, or use the hosted version.
To invite the bot to your server use [this invite link](https://discordapp.com/oauth2/authorize?client_id=199657080083316737&scope=bot).
It requires no special permissions at this time (only read/write to channels).
### Trivia Questions
Questions are obtained from [trivia-db on Sourceforge](https://sourceforge.net/projects/triviadb/).
To parse the `.txt` question files, place them in `/data_management/questions/` then run `LoadDB.cpp`.
You need to create the database first. Use the included schema and create the database as `/bot/db/trivia.db`.
LoadDB.cpp takes some time to execute.
### Commands
`` `trivia`` is the base command.
| Argument | Description |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `questions` `interval` | Where `questions` and `interval` are integers. Makes the game last `questions` number of questions, optionally sets the time interval between hints to `interval` seconds. |
| stop | Stops the trivia game currently in the channel the message is sent from, if there is one. |
| help | Prints a help list, similar to this table. |
### Compiling
#### Dependencies
| Name | Website | Notes |
| ------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| boost | [boost.org](http://www.boost.org/) | |
| websocketpp | [zaphoyd/websocketpp](https://github.com/zaphoyd/websocketpp) | Included as submodule. |
| cURL | [curl.haxx.se](https://curl.haxx.se/) | |
| sqlite3 | [sqlite.org](https://www.sqlite.org/) | Included as submodule. Uses a [different repo](https://github.com/azadkuh/sqlite-amalgamation/). |
| nlohmann/json | [nlohmann/json](https://github.com/nlohmann/json) | (Slightly modified) source file included in repo. |
#### Linux (debian)
1. Clone the github repo: `git clone https://github.com/jackb-p/TriviaDiscord.git TriviaDiscord`
2. Navigate to repository directory: `cd TriviaDiscord`
3. Clone the submodules: `git submodule init` and `git submodule update`
4. Install other dependencies: `sudo apt-get install cmake libboost-all-dev libcurl-dev`
5. `cd TriviaBot`
6. `cmake .`
7. `make`
### Running
To run simply execute the program: `./TriviaBot`
If you do not want to be prompted for your token every launch, provide it as an argument: `./TriviaBot {TOKEN}`