Skip to content
This repository was archived by the owner on Sep 9, 2022. It is now read-only.

Commit 14fe9a5

Browse files
committed
Updated readme
1 parent f941279 commit 14fe9a5

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# Toolerino
22

3-
C# Twitch App to help with spam and banning bots
3+
C# Twitch App to help with spam and banning bots with inspiration from [WetTurtoise's Turtlerino](https://github.com/WetTortoise/turtlerino/)
4+
5+
## How to use the program
6+
1. Download the latest release from the [Releases tab](https://github.com/MrAuro/Toolerino/releases/)
7+
2. Extract the downloaded zip to a safe location and run the `Toolerino.exe` inside of there
8+
3. A console and a form will popup. Put your [OAuth](https://twitchapps.com/tmi) in the OAuth textbox and channel and click create connections.
9+
- Wait for all of the connections to join the channel:
10+
![Image showing the console saying "Joined <channel>" multiple times](./assets/connect.png)
11+
4. All good to go! Your OAuth will be saved so you don't have to manually input it everytime
12+
13+
**If you need any help, feel free to ask in my Twitch chat, #auror6s**
14+
15+
## Rate Limits
16+
I recommend you read Twitch's IRC rate limits which are available [here](https://dev.twitch.tv/docs/irc/guide#command--message-limit)
17+
18+
A normal user account has rate limits of **20/30s**. This means 20 requests for every 30 seconds. Moderators and broadcasters have higher limits, at **100/30s**. Verified bots have limits of **7500/30s**, which allows them to send messages really quickly, for a long amount of time
19+
20+
Below are some of my recommendations for the rate limit inputs (connections and chunk size for filesays)
21+
22+
| | Normal Users | Verified Bots |
23+
|-------------|--------------|---------------|
24+
| Connections | 10 | 30 |
25+
| Chunk Size | 90 | 2000 |
26+
27+
If you have a list of strings in the filesay box and it is over the chunk size, it will be chunked. So 90 (or 2000) messages will be sent, then it will wait 30 seconds before doing the next chunk. You can view the status of a chunked list in the console or the progress bar below.
28+
29+
---
30+
31+
**If you find a bug or a problem, please [create an issue](https://github.com/mrauro/toolerino/issues) (make sure someone else doesn't have a similar problem by using the search box)**
32+
33+
Also feel free to create a pull request if you want to help contribute to the project!

assets/connect.png

33.7 KB
Loading

0 commit comments

Comments
 (0)