From 5b75c78de3020e73d30d8a5f4167841c7bde9b1c Mon Sep 17 00:00:00 2001 From: xenofem Date: Thu, 14 May 2020 15:34:42 -0400 Subject: [PATCH] update README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0328e0d..78375b3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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 @@ -12,5 +12,16 @@ Put some text into `corpus.txt`, and then run source env/bin/activate pip install discord.py python markov-prep.py - echo > token + cp config.json.example config.json + vi config.json 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