feat(docs): bunch of updates and changes and crap
All checks were successful
Pylint / Pylint (3.11) (push) Successful in 43s

This commit is contained in:
SeaswimmerTheFsh 2024-01-04 21:57:54 -05:00
parent dd4e319a0a
commit b7da03f701
Signed by: cswimr
GPG key ID: 1EBC234EEDA901AE
9 changed files with 369 additions and 113 deletions

View file

@ -0,0 +1,52 @@
# Case Commands
/// admonition | These commands are slash commands.
type: warning
Please make sure to enable them with [`[p]slash enable <command>`](https://docs.discord.red/en/stable/cog_guides/core.html#slash-enable), then sync them with [`[p]slash sync`](https://docs.discord.red/en/stable/cog_guides/core.html#slash-sync).
///
## history
/// admonition | All of the arguments for this command are optional.
type: info
///
- Usage: `/history [target] [moderator] [pagesize] [page] [ephemeral] [inline] [export]`
- If both `target` and `moderator` are not present, all moderations for the server will be queried.
- `target:` User whose infractions to query, overrides moderator if both are given
- `moderator:` Moderator whose infractions to query
- `pagesize:` Amount of infractions to list per page
- `page:` Page to select
- `ephemeral:` Hide the command response
- `inline:` Display infractions in a grid arrangement
- `export:` Exports the server's entire moderation history to a JSON file
List previous infractions.
## resolve
- Usage: `/resolve <case> [reason]`
- `case:` (Required) Case number of the case you're trying to resolve
- `reason:` (Optional) Reason for resolving case
Resolve a specific case.
## case
- Usage: `/case <case> [ephemeral] [evidenceformat] [changes] [export]`
- `case:` (Required) What case are you looking up?
- `ephemeral:` (Optional) Hide the command response
- `evidenceformat:` (Optional) …
- `changes:` (Optional) List the changes made to the case
- `export:` (Optional) Export the case to a JSON file or codeblock
Check the details of a specific case.
## edit
- Usage: `/edit <case> <reason> [duration]`
- `case:` (Required) What case are you editing?
- `reason:` (Required) What is the new reason?
- `duration:` (Optional) What is the new duration? Does not reapply the moderation if it has already expired.
Edit the reason of a specific case.

View file

@ -0,0 +1,204 @@
# Configuration
## auroraset
- Usage: `[p]auroraset`
- Aliases: `moderationset, modset, moderationsettings, aurorasettings, and auroraconfig`
Manage moderation commands.
### auroraset ignorebots
- Usage: `[p]auroraset ignorebots`
- Restricted to: `ADMIN`
Toggle if the cog should ignore other bots' moderations.
### auroraset user
- Usage: `[p]auroraset user`
Manage configurations for user configuration options.
#### auroraset user history
- Usage: `[p]auroraset user history`
Manage configuration for the /history command.
##### auroraset user history inline
- Usage: `[p]auroraset user history inline`
Manage configuration for the /history command's inline argument.
###### auroraset user history inline toggle
- Usage: `[p]auroraset user history inline toggle <enabled>`
Enable the /history command's inline argument by default.
##### auroraset user history inline pagesize
- Usage: `[p]auroraset user history inline pagesize <pagesize>`
Set the amount of cases to display per page.
#### auroraset user history pagesize
- Usage: `[p]auroraset user history pagesize <pagesize>`
Set the amount of cases to display per page.
#### auroraset user history ephemeral
- Usage: `[p]auroraset user history ephemeral <enabled>`
- Aliases: `hidden and hide`
Toggle if the /history command should be ephemeral.
### auroraset user autoevidence
- Usage: `[p]auroraset user autoevidence <enabled>`
Toggle if the evidenceformat codeblock should be sent automatically.
## auroraset server
- Usage: `[p]auroraset server`
- Restricted to: `ADMIN`
Manage default configurations for user configuration options, per server.
### auroraset server history
- Usage: `[p]auroraset server history`
- Restricted to: `ADMIN`
Manage configuration for the /history command.
#### auroraset server history inline
- Usage: `[p]auroraset server history inline`
- Restricted to: `ADMIN`
Manage configuration for the /history command's inline argument.
##### auroraset server history inline pagesize
- Usage: `[p]auroraset server history inline pagesize <pagesize>`
- Restricted to: `ADMIN`
Set the amount of cases to display per page.
##### auroraset server history inline toggle
- Usage: `[p]auroraset server history inline toggle <enabled>`
- Restricted to: `ADMIN`
Enable the /history command's inline argument by default.
#### auroraset server history ephemeral
- Usage: `[p]auroraset server history ephemeral <enabled>`
- Restricted to: `ADMIN`
- Aliases: `hidden and hide`
Toggle if the /history command should be ephemeral.
#### auroraset server history pagesize
- Usage: `[p]auroraset server history pagesize <pagesize>`
- Restricted to: `ADMIN`
Set the amount of cases to display per page.
### auroraset server autoevidence
- Usage: `[p]auroraset server autoevidence <enabled>`
Toggle if the evidenceformat codeblock should be sent automatically.
## auroraset showmoderator
- Usage: `[p]auroraset showmoderator`
- Restricted to: `ADMIN`
Toggle if the cog should show the moderator in the case embed when dming a user.
## auroraset immunity
- Usage: `[p]auroraset immunity`
- Restricted to: `ADMIN`
Manage configuration for immune roles.
### auroraset immunity add
- Usage: `[p]auroraset immunity add <role>`
- Restricted to: `ADMIN`
Add a role to the immune roles list.
### auroraset immunity remove
- Usage: `[p]auroraset immunity remove <role>`
- Restricted to: `ADMIN`
Remove a role from the immune roles list.
### auroraset immunity list
- Usage: `[p]auroraset immunity list`
- Restricted to: `ADMIN`
List all immune roles.
## auroraset permissions
- Usage: `[p]auroraset permissions`
- Restricted to: `ADMIN`
Toggle whether the bot will check for discord permissions.
## auroraset logchannel
- Usage: `[p]auroraset logchannel [channel=None]`
- Restricted to: `ADMIN`
Set a channel to log infractions to.
## auroraset import
- Usage: `[p]auroraset import`
- Restricted to: `ADMIN`
Import moderations from other bots.
### auroraset import galacticbot
- Usage: `[p]auroraset import galacticbot`
- Restricted to: `ADMIN`
Import moderations from GalacticBot.
### auroraset import aurora
- Usage: `[p]auroraset import aurora`
- Restricted to: `ADMIN`
Import moderations from another bot using Aurora.
## auroraset dm
- Usage: `[p]auroraset dm`
- Restricted to: `ADMIN`
Toggle automatically messaging moderated users.<br/><br/>This option can be overridden by specifying the `silent` argument in any moderation command.
## auroraset list
- Usage: `[p]auroraset list`
- Aliases: `view and show`
List all moderation settings.
## auroraset blacklist
- Usage: `[p]auroraset blacklist`
- Restricted to: `ADMIN`
Manage configuration for the /blacklist command.
### auroraset blacklist list
- Usage: `[p]auroraset blacklist list`
- Restricted to: `ADMIN`
List all blacklist types.
### auroraset blacklist remove
- Usage: `[p]auroraset blacklist remove <role>`
- Restricted to: `ADMIN`
Remove a role's blacklist type.
### auroraset blacklist add
- Usage: `[p]auroraset blacklist add <role> <duration>`
- Restricted to: `ADMIN`
Add a role to the blacklist.
# timedeltaconvert
- Usage: `[p]timedeltaconvert <duration>`
- Aliases: `tdc`
This command converts a duration to a [`timedelta`](https://docs.python.org/3/library/datetime.html#datetime.timedelta) Python object.<br/><br/>**Example usage**<br/>`[p]timedeltaconvert 1 day 15hr 82 minutes 52s`<br/>**Output**<br/>`1 day, 16:22:52`

11
.docs/aurora/index.md Normal file
View file

@ -0,0 +1,11 @@
# Aurora
Aurora is a fully-featured moderation system. It is heavily inspired by GalacticBot, and is designed to be a more user-friendly alternative to Red's core Mod cogs.
## Installation
```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs aurora
[p]cog load aurora
```

View file

@ -0,0 +1,82 @@
# Moderation Commands
/// admonition | These commands are slash commands.
type: warning
Please make sure to enable them with [`[p]slash enable <command>`](https://docs.discord.red/en/stable/cog_guides/core.html#slash-enable), then sync them with [`[p]slash sync`](https://docs.discord.red/en/stable/cog_guides/core.html#slash-sync).
///
## note
- Usage: `/note <target> <reason> [silent]`
- `target:` (Required) Who are you noting?
- `reason:` (Required) Why are you noting this user?
- `silent:` (Optional) Should the user be messaged?
Add a note to a user.
## warn
- Usage: `/warn <target> <reason> [silent]`
- `target:` (Required) Who are you warning?
- `reason:` (Required) Why are you warning this user?
- `silent:` (Optional) Should the user be messaged?
Warn a user.
## blacklist
- Usage: `/blacklist <target> <role> <reason> [silent]`
- `target:` (Required) Who are you blacklisting?
- `role:` (Required) What blacklist type are you applying to the target?
- `reason:` (Required) Why are you blacklisting this user?
- `silent:` (Optional) Should the user be messaged?
Add a blacklist role to a user.
## mute
- Usage: `/mute <target> <duration> <reason> [silent]`
- `target:` (Required) Who are you unbanning?
- `duration:` (Required) How long are you muting this user for?
- `reason:` (Required) Why are you unbanning this user?
- `silent:` (Optional) Should the user be messaged?
Mute a user.
## unmute
- Usage: `/unmute <target> [reason] [silent]`
- `target:` (Required) Who are you unmuting?
- `reason:` (Optional) Why are you unmuting this user?
- `silent:` (Optional) Should the user be messaged?
Unmute a user.
## kick
- Usage: `/kick <target> <reason> [silent]`
- `target:` (Required) Who are you kicking?
- `reason:` (Required) Why are you kicking this user?
- `silent:` (Optional) Should the user be messaged?
Kick a user.
## ban
- Usage: `/ban <target> <reason> [duration] [delete_messages] [silent]`
- `target:` (Required) Who are you banning?
- `reason:` (Required) Why are you banning this user?
- `duration:` (Optional) How long are you banning this user for?
- `delete_messages:` (Optional) How many days of messages to delete?
- `silent:` (Optional) Should the user be messaged?
Ban a user.
## unban
- Usage: `/unban <target> [reason] [silent]`
- `target:` (Required) Who are you unbanning?
- `reason:` (Optional) Why are you unbanning this user?
- `silent:` (Optional) Should the user be messaged?
Unban a user.