diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 68 |
1 files changed, 67 insertions, 1 deletions
@@ -1,2 +1,68 @@ -# redpilled-bot +# ilotterytea's redpilled bot +A feature-rich chatbot for Twitch. It is written in C++17 and uses the Twitch API/IRC custom library. + +> The bot in real action can be seen at [https://twitch.tv/teabot](https://twitch.tv/teabot) + +## Features ++ Listening to stream start/end ++ Mass-pinging chatters ++ Timer ++ Custom commands + +## Prerequisites + ++ C++ compiler *(I tested only GCC)* ++ PostgreSQL + +## Installation Guide (Linux) + +### 1. Clone the Git repository + +```bash +git clone https://git.ilotterytea.kz/services/bot +cd bot +``` + +### 2. Run the SQL migrations + +All SQL migrations are located in the corresponding `/migrations` folder. + +You can run all `up.sql` in sequence yourself or you can use [a special program created for this purpose](https://git.ilotterytea.kz/tools/sql_migrator) and run the related command: + +`sqlm run --db-name DB_NAME --db-user DB_USER --db-pass DB_PASS` + +### 3. Build the project + +```bash +mkdir build +cd build +cmake .. -DUSE_TLS=1 +make +``` + +### 4. Create the configuration file + +The configuration file is in `KEY=VALUE` format. \ +Here's example of `.env` file with required parameters. This file should be along with compiled executable. + +```env +db_name=DB_NAME +db_user=DB_USER +db_pass=DB_PASS +twitch_credentials.client_id=CLIENT_ID +twitch_credentials.token=TOKEN +``` + +### 5. Run the bot + +```bash +./redpilledbot +``` + +## Dependencies + ++ ixwebsocket (for Twitch connections) ++ pqxx (for databases) ++ cpr (for HTTP requests) ++ nlohmann/json (for JSON data deserialization)
\ No newline at end of file |