xevion/contest-assistant
1
0
Fork 0
mirror of https://github.com/Xevion/contest-assistant.git synced 2025-12-05 23:14:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README to latest project specifications

Browse Source 
Still a fair bit more to go, apparently.
This commit is contained in:
Xevion
2021-02-18 07:51:37 -06:00
parent fdc64012b0
commit 0ee89fc607
1 changed files with 21 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -14,29 +14,21 @@ python main.py
## Commands
Default prefix is `$`, change it as you please.
Default prefix is `$` or by mentioning the bot. Change it with the `prefix` command.
```
$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.
advance [duration] [pingback = True]
Advance the state of the current period pertaining to this Guild.
close
Closes the current period.
leaderboard
Prints a leaderboard
prefix <new_prefix>
Changes the bot's saved prefix.
status
Provides the bot's current state in relation to internal config...
submission <channel>
Changes the bot's saved submission channel.
```
## Features
@@ -44,11 +36,14 @@ $calculate
- [X] Customizable prefix
- [X] Ensure 1-2 char length
- [ ] Ensure ASCII
- [ ] Adds upvote reactions automatically to the designated submissions channel
- [ ] Removes regular messages and videos
- [ ] Deletes user's previous submissions if they upload more than one per period.
- [ ] Only tracks submissions per period - previous periods are ignored.
- [X] Adds upvote reactions automatically to the designated submissions channel
- [X] Removes regular messages
- [ ] Remove Videos or Gifs
- [X] Regular Messages
- [X] Deletes user's previous submissions if they upload more than one per period.
- [X] Only tracks submissions per period - previous periods are ignored.
- [ ] Removes user's previous reactions if they vote more than once.
- [X] Ignore/remove reactions added to non-submission message in the channel (preserve)
- [ ] Calculates the winners automatically.
- [ ] Handles submission removal
- [X] Handles submission removal
- [ ] Automatically switches between periods if a duration is specified