From c08eb5408153d96ffc188a5a4c48db21d2cd9192 Mon Sep 17 00:00:00 2001 From: c0de Date: Mon, 3 Oct 2022 19:58:48 -0500 Subject: [PATCH] Update readme --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/readme.md b/readme.md index eaa81b6..2ec9626 100644 --- a/readme.md +++ b/readme.md @@ -15,3 +15,20 @@ The point scale is: There should also be a running total for each player that can be checked with a command. ## Requirements + +You will need a discord bot already set up and supply an auth token. + +Python requirements can be installed with `pipenv install` (install pipenv with `pip3 install pipenv`) + +## Usage + +All of the new bot code is in the [GhostBallBot](./GhostBallBot/) folder. This documentation is for the new code. + +The original code is in [src](./src/). Feel free to try to get this working. + +1. Install the python requirements +1. Add discord token to run.sh +1. Execute run.sh +1. Bot should then connect to discord and start responding to commands defined in game.py + +