Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tearzz committed Apr 11, 2019
1 parent 125c38e commit 71a66bb
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ Twitch chatbot written in Ruby.

---

### Features

* Threading

* Global ban protection

* Easy command management

* Color output

---

### Setup

Create a file called **credentials.txt**, add the following three lines to it:

```
Expand All @@ -12,12 +26,26 @@ botname
channel
```

_Of course you're going to replace the oauth token, botname and channel with your own values._

That's it! Now you can run it, either by double clicking `main.rb` or by running `ruby main.rb` from the console.

---

### To-Do
### Configuration

- [x] Add delay between requests
The first couple of lines in `configurator.rb` contains two global variables. `prefix` and `max_messages`.

`prefix` is the symbol a person in chat uses to trigger a command.

`max_messages` is the max amount of messages to keep in the queue which the chat bot is going to respond to.

---

### To-Do

- [x] Add API commands

- [x] Add delay between requests

- [x] Add response loading from files

0 comments on commit 71a66bb

Please sign in to comment.