black-mesa

README

Black Mesa

Black Mesa is a Discord Moderation bot designed with Performance, Reliability and Customization in mind.

Self Host Guide

Docker

The prefered and supported method of running the bot is via Docker with the provided docker-compose.yml.example file, you will be up and running in no time!

Installation (Linux)

• You must first ensure you have up to date versions of Docker and Docker Compose
• Download the source code for the project with git clone https://github.com/blackmesadev/black-mesa.git
• You will then need to cp docker-compose.yml.example docker-compose.yml
• Open the docker-compose.yml file with your preferred text editor and ensure you set the correct enviornment variables, they are listed accordingly. Do NOT forget to set a password for mongodb.
• Once your docker-compose.yml file is in a state that you are happy with it, simply run docker-compose up --build -d to build and bring up the container detached.

Installation (Windows)

• why are you trying to run a bot on windows

Usage

MongoDB

Black Mesa uses MongoDB as the database and will use it to read and write configuration data, actions and logs.

Black Mesa also uses Redis for short term variable sharing such as keeping record of CPU/Memory Usage, Automod Data, etc.

Black Mesa configuration is in docker-compse.yml, this is where you will store your Token, Mongo DB URI and Redis URI

If you are using Docker you will need to docker-compose build again before the configuration updates.

License