update README
This commit is contained in:
parent
0d6ba5e8a8
commit
5b75c78de3
15
README.md
15
README.md
|
@ -1,6 +1,6 @@
|
||||||
# markov-bot
|
# markov-bot
|
||||||
|
|
||||||
Markov chain discord bot, sends randomly generated sentences once an hour and when mentioned.
|
Markov chain discord bot, sends randomly generated sentences at configurable intervals and when mentioned.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
@ -12,5 +12,16 @@ Put some text into `corpus.txt`, and then run
|
||||||
source env/bin/activate
|
source env/bin/activate
|
||||||
pip install discord.py
|
pip install discord.py
|
||||||
python markov-prep.py
|
python markov-prep.py
|
||||||
echo <token> > token
|
cp config.json.example config.json
|
||||||
|
vi config.json
|
||||||
python markov-bot.py
|
python markov-bot.py
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
- `mode`: can be `reply`, to reply to occasional messages, or `timed`, to send messages unprompted to random channels at a set interval
|
||||||
|
- `reply_invfreq`: in `reply` mode, will reply to one in N messages on average
|
||||||
|
- `reply_delay_min`: minimum amount of time to wait before sending a reply
|
||||||
|
- `reply_delay_max`: maximum amount of time to wait before sending a reply
|
||||||
|
- `timed_interval_min`: in `timed` mode, minimum time between successive messages in the same guild
|
||||||
|
- `timed_interval_max`: maximum time between successive messages in the same guild
|
||||||
|
- `token`: Discord bot API token
|
||||||
|
|
Loading…
Reference in a new issue