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 Discord server.
For premium join our Support Server.
To know the progress of our project check our Progress Board.
Click the Sponsor button and choose any one option to support us.
There are many ways you can contribute to this project:
For more information, please see our contributing guidelines.
The issue tracker here is only for bug reports and suggestions. Please do not use it to ask a question. Instead, ask it on our Discord server.
This self-hosting guide requires you to have some basic knowledge about command line, Python, and Discord bots.
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.
Installing Python 3:-
Follow this guide to install python :- Here
Installing Git:-
Follow this guide to install git :- Here
Installing Ffmpeg:-
Follow this guide to install ffmpeg :- Here
Installing Postgresql:-
Follow this guide to install Postgresql :- Here
Installing Redis :-
Follow this guide to install Redis :- Here
Clone this repository, or fork and clone if you wish to make pull requests.
git clone https://github.com/ReyBotDev/Modmail-Bot.gitConfiguration is done through a config.py file. A template can be found in config.example.py.
You can create a copy of it and rename it to config.py, then fill in the configurations.
ModMail utilises several modules to function properly. The list of modules can be found
in requirements.txt. You can install them with the following command.
pip install -r requirements.txtCongratulations! You have set up everything, and you can finally have the bot up and running. Use the following command to start the bot.
python3 launcher.pyThis project is licensed under GNU Affero General Public License v3.0.
Please check our Code Of Conduct here for knowing more.
Please check our Security Policy here to know more.
Chamburr for providing modmail base.