mirror of
https://github.com/Xevion/contest-assistant.git
synced 2026-01-31 04:23:51 -06:00
setup bot with feature list and command schema/list, update requirements.txt with aiosqlite
This commit is contained in:
@@ -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
|
||||
Reference in New Issue
Block a user