Skip to content

Commit b79f085

Browse files
authored
Update ReadMe
For version 0.4 was added a simple description.
1 parent dedb058 commit b79f085

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# CinderBot
2+
## Description
23
Desktop twitch bot.
4+
## Releases
5+
###Version 0.4
6+
First public version of CinderBot. Its include next features:
7+
* Custom text commands
8+
9+
In file data/data/baseFile.data you can write your own custom commands. One per line. For an example look at the file itself.
10+
11+
* Simple statisticks
12+
13+
For every user bot create a line in data/data/userData.data (file will be created automaticly) which will store:
14+
15+
* Message count
16+
* Currency count
17+
18+
For now, you cannot use currency for anything. And it equals message count (it means, that 1 currency will be added per 1 message in a chat).In future versions it will be changed and upgraded. You can change name of a currency in data/config/config.cfg
19+
20+
* Covenant name
21+
22+
Not used now.
23+
24+
**P.S. To be mantioned, you can ignore some users in statisticks. Just add names in data/config/config.cfg.**
25+
26+
## How to make it work?
27+
Build (only source code available now) with Qt5+, in data/config/config.cfg add your login and oathkey and room name, where bot should work. For more info look at config file itself.

0 commit comments

Comments
 (0)