Update README to latest project specifications

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

View File

@@ -14,29 +14,21 @@ python main.py
## Commands ## 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 advance [duration] [pingback = True]
Changes the prefix of the bot's commands. Advance the state of the current period pertaining to this Guild.
close
$config submissions SUBMISSIONS_CHANNEL Closes the current period.
Changes the channel moderated for submissions. leaderboard
Prints a leaderboard
$start submissions [DURATION = -1] [AUTOFORWARD = true] prefix <new_prefix>
Starts the submissions period. Changes the bot's saved prefix.
status
$start voting [DURATION = - 1] Provides the bot's current state in relation to internal config...
Starts the voting period. submission <channel>
Changes the bot's saved submission channel.
$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 ## Features
@@ -44,11 +36,14 @@ $calculate
- [X] Customizable prefix - [X] Customizable prefix
- [X] Ensure 1-2 char length - [X] Ensure 1-2 char length
- [ ] Ensure ASCII - [ ] Ensure ASCII
- [ ] Adds upvote reactions automatically to the designated submissions channel - [X] Adds upvote reactions automatically to the designated submissions channel
- [ ] Removes regular messages and videos - [X] Removes regular messages
- [ ] Deletes user's previous submissions if they upload more than one per period. - [ ] Remove Videos or Gifs
- [ ] Only tracks submissions per period - previous periods are ignored. - [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. - [ ] 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. - [ ] Calculates the winners automatically.
- [ ] Handles submission removal - [X] Handles submission removal
- [ ] Automatically switches between periods if a duration is specified - [ ] Automatically switches between periods if a duration is specified