README.md

This is an open-source Discord ModMail Bot written in Python.

Steps to self-host:

Clone the repository:

git clone https://github.com/xviinceent/modmail-bot

Navigate to the newly created directory:

cd modmail-bot

Install the dependencies by using:

pip install -r requirements.txt -y

or

pip install aiomysql cryptography discord.py jishaku python-dotenv -y

You also need to set up a MySQL database server in order for the bot to work on multiple servers. If you already have a MySQL database server, put the credentials (HOST, USER, PASSWORD and DB) in a .env file. You also have to add a TOKEN variable that contains your bot's token. You can create a bot here. Head over to the "Bot" section and reset your token to get one. This is an example of how the file can look like:

TOKEN = ...

Also, you have to create a db.json file that contains your database credentials. This is an example of how the file can look like:

{
    "HOST": "localhost",
    "USER": "xviinceent",
    "PASSWORD": "password",
    "DB": "modmail"
}

Run the script by using:

python3 main.py

(This command may vary based on your OS.)

If you don't want to self-host the bot, you can invite the official instance by clicking here!

Adding translations

Go to this file and copy it's content. Fork this repository. Create a new Python file in the strings folder, name it like your language's language tag and translate ONLY THE STRINGS, NOT THE STRING NAMES. Create a pull request.