From 50c2d503dee4e782e8c105027e33517eb821e8f2 Mon Sep 17 00:00:00 2001 From: blackfur <64478051+theblackfurguy@users.noreply.github.com> Date: Fri, 22 Jan 2021 17:39:30 +0100 Subject: [PATCH] Added requirements.txt and explanations --- README.md | 25 +++++++++++++++++++++++++ requirements.txt | 3 +++ run.py | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index f8ef586..dd3cec9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # SheepBotFrame Simple Program to run custom AI Bots on Discord + +## How to install + +` +git clone https://github.com/TheBlackfurGuy/SheepBotFrame.git +cd SheepBotFrame +pip install -r requirements.txt +` +## How to set up +Edit the config.yml file to your likings.
+Change "botname" to the name of the bot (currently has no effect)
+Change "filterpings" to false if you don't want to have pings filtered out.
+Change "excludeprefix" to set the text sequence that will hide a message from the bot
+Change "usechannels" to the IDs of the channels the bot should react in
+Change "trainchannels" to the channel IDs and ammounts the bot should download
+Change "corpus" to all the corpus the bot should train +Change "token" to the Bots token + +## How to run + +This will give you all information you need to get started. + +` +python3 run.py --help +` \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0121b6e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +chatterbot==1.0.2 +PyYAML==3.13 +discord.py \ No newline at end of file diff --git a/run.py b/run.py index 7f5a199..aba9482 100644 --- a/run.py +++ b/run.py @@ -25,7 +25,7 @@ def printhelp(): def printversion(): - print("SheepBotFrame Beta 1.40") + print("SheepBotFrame Beta 1.41") def remove_mention(m, s, i):