A bot for Discord that allows users to DM the bot to contact the server's entire mod team. These DMs get relayed to a modmail server where each user gets their own channel, or "thread". Moderators and admins can then reply to these threads, and these responses are relayed back to the original user as a DM.
Inspired by Reddit's modmail system.
- Install Node.js 8 or higher
- Clone or download this repository
- Create a Discord server to be used as the modmail inbox
- Make a copy of the file
config.example.jsonin the same folder and name the copyconfig.json. Open the file and fill in the values.- You can also find more configurable options at the end of this page!
- Install dependencies:
npm install - Add bot to servers, and make sure to give it proper permissions on the mail server.
- Run the bot:
npm start
!logs <user> Lists previous modmail logs with the specified user
!block <user> Blocks the specified user from using modmail
!unblock <user> Unblocks the specified user from using modmail
!s <shortcut> <text> Adds a snippet (a canned response). See below for how to use it.
!edit_snippet <shortcut> <text> Edits an existing snippet (alias !es)
!delete_snippet <shortcut> Deletes the specified snippet (alias !ds)
!snippets Lists all available snippets
!reply <text> Sends a reply to the user in the format "(Role) User: text" (alias !r)
!anonreply <text> Sends an anonymous reply to the user in the format "Role: text" (alias !ar)
!close Closes the modmail thread and saves a log of it
!logs Lists previous modmail logs with this user
!block Blocks the user from using modmail
!unblock Unblocks the user from using modmail
!!shortcut Reply with a snippet. Replace shortcut with the snippet's actual shortcut.
To automatically reply without using !reply or !r, enable alwaysReply in the config. alwaysReplyAnon sets whether to reply anonymously. If you do not wish to reply, it will ignore any message starting in the prefix (which defaults to !), such as !note
These go in config.json. See also config.example.json.
| Option | Default | Description |
|---|---|---|
| token | None | Required! The bot user's token |
| mailGuildId | None | Required! The inbox server's ID |
| mainGuildId | None | ID of the main server where people contact the bot from, used for e.g. displaying users' nicknames |
| prefix | "!" | Prefix for bot commands |
| status | "Message me for help" | The bot's "Playing" text |
| responseMessage | "Thank you for your message! Our mod team will reply to you here as soon as possible." | The bot's response to DMs that start a new thread |
| alwaysReply | false | If set to true, all messages in modmail threads will be relayed back to the user, even ones without !r |
| alwaysReplyAnon | false | If alwaysReply is set to true, this option controls whether the auto-reply is anonymous |
| useNicknames | false | If set to true, mod replies will use their nickname (on the inbox server) instead of their username |
| ignoreAccidentalThreads | false | If set to true, the bot attempts to ignore common "accidental" messages that would start a new thread, such as "ok", "thanks", etc. |
| enableGreeting | false | Set to true to send a welcome message to new main guild members. Requires mainGuildId to be set. |
| greetingMessage | None | Text content of the welcome message |
| greetingAttachment | None | Path to an image or other attachment to send along with the greeting |
| port | 8890 | Port from which to serve attachments and logs |
| url | None | URL to use for attachment and log links. Defaults to IP:PORT |
| snippetPrefix | "!!" | Prefix to use snippets. Defaults to prefix x2. |
| inboxServerPermission | None | Permission required to use bot commands on the inbox server |
| logChannelId | Server's default channel | Channel where to post links to closed threads and other alerts |
| newThreadCategoryId | None | ID of the category where new modmail thread channels should be placed |