Table of contents

Getting started

We recommend you use our own instance - which you can invite using this invite link, but you could also run your own instance with the instructions found in the GitHub repo.

Requested permissions rundown

• Manage Roles is required for our alert functionality - but the bot can instead ping individual users if you simply don’t set an alert role, making this the only optional permission.
• Send Messages in Threads, Create Public Threads, Manage Messages, and Manage Threads are all required for us to make use of Discord’s thread channels.
• Read Messages, Embed Links, Attach Files, and Read Message History are all required for core functionality when posting messages from your staff team/the end user and they are not optional.

Initial setup

Making your staff team able to use the bot

Once you’ve invited the bot, you might notice that no one but folks with the Administrator permission can run any commands. You’ll want to head to Server Settings → Integrations → ModMail. The important stuff will look something like this:

At the time of writing this, Discord’s UI is incomplete and this isn’t reflective of what’s actually going on, so don’t worry about @everyone showing up as a green tick.

What you’ll want to do is hit the Add Roles or Members button for the Roles & Members section and select a role you want to be able to use the bot. Assuming your role is called Mod, this should now look something like this:

Configuration

Next up, pull up /config. You’ll notice that there’s only 5 options, let’s go over each one:

1. modmail-channel - This is where the bot will create new thread channels when a user reaches out to ModMail. You need to set this to something - once you do, the bot will start listening for DMs from your users.
2. greeting - You don’t need to set this to anything! This is a message that’ll be automatically sent to the user when a new thread is opened. You could set this to something like “Hello! Our team will get back to you as soon as possible!”
3. farewell - Very similar to greeting, except this will be sent once the thread is closed. Don’t worry though, you can silently close threads to make exceptions!