Skip to content

Commit b31590a

Browse files
committed
Update new commands list
1 parent d838269 commit b31590a

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

README.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,36 @@ If you are keen to stay updated with the latest features then follow the updatin
4949

5050
## Commands
5151

52-
| Name | Description |
53-
|--------------|----------------------------------------------------------------------|
54-
| setup | Sets up the categories that will be used by the bot. |
55-
| about | Shows some general information about the bot. |
56-
| contact | Allows a moderator to initiate a thread with a given recipient. |
57-
| reply | Sends a message to the current thread's recipient. |
58-
| close | Closes the current thread and deletes the channel. |
59-
| archive | Closes the thread and moves the channel to the archive category. |
60-
| block | Blocks a user from using modmail |
61-
| blocked | Shows a list of users that are currently blocked |
62-
| unblock | Unblocks a user from using modmail |
63-
| snippets | Shows a list of snippets that are currently configured. |
64-
| customstatus | Sets the bot playing status to a message of your choosin |
65-
| disable | Closes all threads and disables modmail for the server. |
66-
| update | Checks for new versions and updates the bot, follow the [updating guide](https://github.com/kyb3r/modmail/wiki/Updating) to use this command. |
52+
### Modmail related
53+
54+
| Name | Command |
55+
|----------|------------------------------------------------------------|
56+
| setup | Sets up a server for modmail |
57+
| reply | Reply to users using this command. |
58+
| edit | Edit a message that was sent using the reply command. |
59+
| contact | Create a thread with a specified member. |
60+
| close | Close the current thread. |
61+
| logs | Shows a list of previous modmail thread logs of a member. |
62+
| block | Block a user from using modmail. |
63+
| blocked | Returns a list of blocked users |
64+
| unblock | Unblocks a user from using modmail. |
65+
| nsfw | Flags a modmail thread as nsfw. |
66+
| snippets | Returns a list of snippets that are currently set. |
67+
| mention | Changes what the bot mentions at the start of each thread. |
68+
69+
### Utility commands
70+
| Name | Command |
71+
|----------|------------------------------------------------------------|
72+
| help | Shows the help message. |
73+
| update | Checks for new versions and updates the bot |
74+
| github | Shows the github user your modmail api token is linked to. |
75+
| prefix | Changes the prefix for the bot. |
76+
| alias | Returns a list of aliases that are currently set. |
77+
| about | Shows information about the bot. |
78+
| status | Set a custom playing status for the bot. |
79+
| ping | Pong! Returns your websocket latency. |
80+
| eval | Evaluates python code (Bot owner only) |
81+
| config | Manually hange configuration for the bot. |
6782

6883
## Features
6984

@@ -73,6 +88,9 @@ Snippets are shortcuts for predefined messages that you can send. You can add sn
7388
### Custom Mentions
7489
If you want the bot to mention a specific role instead of `@here`, you need to set a config variable `MENTION` and set the value to the mention of the role or user you want mentioned. To get the mention of a role or user, type `\@role` in chat and you will see something like `<@&515651147516608512>` use this string as the value for the config variable.
7590

91+
### Thread Logs
92+
Thread conversations are automatically logged and a log link (logs.modmail.tk) is provided with each thread.
93+
7694
### Delete Linked Messages
7795
Did you accidentally send something you didnt mean to with the `reply` command? Dont fret, if you delete the original message on your side, this bot automatically deletes the corresponding message that was sent to the recipient of the thread!
7896

0 commit comments

Comments
 (0)