ModMail

A feature-rich Discord bot for easy communication between server staff and users.

A new channel is created whenever a user messages the bot, and the channel will serve as a shared inbox for seamless communication between staff and the user.

To learn more, check out our website or visit our Discord server.

Contributing

Want to contribute? Awesome! There are many ways you can contribute to this project, for example:

• Submitting bugs and feature requests
• Reviewing changes
• Contribute directly to the code base
• Sponsoring the project (Please let CHamburr#2591 know on Discord)

For more information on contributing, please see the contributing guidelines.

The issue tracker here is only for bug reports and feature requests. Please do not use it to ask a question. Instead, ask it on our Discord server.

Self-Hosting

This self-hosting guide requires you to have some basic knowledge about command line, Python, and Discord bots. We do not provide any support for self-hosting.

Prerequisites

In order to run ModMail, you will need to install the following software. Please also note that ModMail can only be hosted on UNIX based operating systems. Windows is not supported.

• Git
• Python 3
• PostgreSQL
• Redis

Getting the Sources

Please fork this repository so that you can make pull requests. Then, clone your fork.

git clone https://github.com/<github-username>/modmail.git

Sometimes you may want to merge changes from the upstream repository to your fork.

git checkout master
git pull https://github.com/frcdiscord/modmail.git master

Configuration

Configuration is done through a config.py file. You should make a copy of config.example.py and rename it to config.py. All fields must be filled in, except for bot list tokens and the Sentry URL only if you have testing set to False.

Installing Modules

ModMail utilises discord.py and several other modules to function properly. The list of modules can be found in requirements.txt and you can install them with the following command.

pip3 install -r requirements.txt

Running the Bot

Congratulations! You have set up everything and you can finally have the bot up and running. Use the following command to run.

python3 launcher.py

Code of Conduct

This project is governed by Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

License

This project is licensed under GNU Affero General Public License v3.0.