diff --git a/README.md b/README.md new file mode 100644 index 0000000..d88cc25 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# contest-assistant + +A somewhat simple but feature concentrated bot to automate photography contests. + +## Setup + +``` +git clone git@github.com:Xevion/contest-assistant.git +cd ./contest-assistant/ +# Create a virtual environment if necessary +pip install -r requirements.txt +python main.py +``` + +## Commands + +Default prefix is `$`, change it as you please. + +``` +$config prefix PREFIX + Changes the prefix of the bot's commands. + +$config submissions SUBMISSIONS_CHANNEL + Changes the channel moderated for submissions. + +$start submissions [DURATION = -1] [AUTOFORWARD = true] + Starts the submissions period. + +$start voting [DURATION = - 1] + Starts the voting period. + +$stop submissions + Stops the submissions period. + +$stop voting + Stops the voting period. + +$calculate + Calculates and prints a scoreboard of all submissions with the submitting user and a link to their submission. +``` + +## Features + +- [ ] Customizable prefix + - [ ] Ensure 1 ASCII char length +- [ ] Adds upvote reactions automatically to the designated submissions channel +- [ ] Deletes user's previous submissions if they upload more than one per period. + - [ ] Only tracks submissions per period - previous periods are ignored. +- [ ] Removes user's previous reactions if they vote more than once. +- [ ] Calculates the winners automatically. +- [ ] Automatically switches between periods if a duration is specified diff --git a/requirements.txt b/requirements.txt index 2d551de..c48428a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,3 @@ discord~=1.0.1 + +aiosqlite~=0.16.1