How does it work?

When a user sends a direct message to the bot, a channel is created within an isolated category. This channel is where messages will be relayed. To reply to the message, simply use the command reply in the channel. See a full list of commands in the wiki.

Installation

Currently the easiest and fastest way to set up the bot is using Heroku which is a service that offers a free plan for hosting applications. If you choose to install the bot using Heroku, you will not need to download anything. Read the installation guide. If you ran into any problems, join our discord server for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! 😉

Notable Features

Customizability

There is a range of config variables you can dynamically change with the config command to change the appearance of the bot. For example embed color, responses, reactions, status etc. Snippets and custom command aliases are also supported, snippets are shortcuts for predefined messages that you can send. Add and remove snippets with the snippets command. The list of things you can change is ever growing thanks to the community for code contributions.

Linked Messages

Did you accidentally send something you didn't mean to with the reply command? Don't 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! This also works when you use the edit command to edit a message you have sent.

Thread Logs

Thread conversations are automatically logged and a log link is provided with each thread. Logs are rendered with HTML and are presented in an aesthetically pleasing way, exactly like on discord, this especially integrates seamlessly with the mobile version of discord. Here's a link to an example.

Automatic Updates

The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a disable_autoupdates config variable.

Contributing

This project is licenced under MIT. If you have ideas for commands create an issue or pull request. Contributions are always welcome, whether it be documentation improvements or new functionality, please feel free to create a pull request.

If you use Modmail and love it, consider supporting me on Patreon ❤️