Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 427dfde

Browse files
committedFeb 21, 2025
docs(report): update usage info, document new features
1 parent 6741491 commit 427dfde

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed
 

‎README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -323,15 +323,14 @@ Allows roles to be applied and removed using reactions.
323323

324324
This cog will allow members to send a report into a channel where it can be reviewed and actioned upon by moderators.
325325

326-
- `[p]reports logchannel #admin-log` - For reports to be able to be taken, a log channel must be set which will receive an embed upon a user using the report command.
327-
328-
- `[p]reports channel [allow|deny] [channel]` - Disallow the `report`/`emergency` commands to be used in certain channels
329-
330-
- `[p]reports confirm [true|false]` - When a report is issued, this sets whether the bot will DM the user with confirmation or not
331-
332-
- `[p]report [message]` - A report can be sent to the logchannel for any moderators to see and action upon when they are ready.
333-
334-
- `[p]emergency [message]` - An emergency can be requested which will ping all members in the configured logchannel if they are online.
326+
- `[p]reports confirmation <true|false>` - Sets whether the bot will send users a confirmation/copy of their report.
327+
- `[p]reports logchannel #admin-log` - Set the channnel to which reports will be sent. ⚠️ The cog will not function without this.
328+
- `[p]reports status` - Output the cog's configurationn status.
329+
- `[p]report <message>` - Sends a report with the given message.
330+
- `[p]emergency <message>` - Sends a report with the given message, mentioning (@'ing) all users in the configured `logchannel` who are in either an online or idle state.
331+
332+
> [!TIP]
333+
> The `report` and `emergency` commands are also implemented as slash commands.
335334
336335
### role\_welcome
337336

0 commit comments

Comments
 (0)
Please sign in to comment.