IRMCTracker

A discord bot for tracking Iranian Minecraft servers and showing the statistics of them

Installation

Installation needs a valid installation of Python > 3.6

Use the package manager pip to install requirments.txt

pip install -r requirments.txt

Before running the bot

Copy storage/data/.env.sample to storage/data/.env and update tokens/prefixes etc as desired

After running the bot

1. Add servers to tracker database (No need to restart after that, bot will fetch the newly added servers):
   • Directly using database management softwares
   • Through commands (~/cog/admin.py)

Usage

# Run the discord bot
python main.py run

# Fetching all servers and updating them in database
python main.py db:update

# Running tests/test_basic.py for testing purposes
python main.py test

Build and run the container

Install Docker, e.g. Download Docker.

Enter the docker-compose.yml file in the main Directory and fill in the following values as desired and according to the settings of the /storage/data/.env file:

# Database port change values
ports:
      - "3306:3306"

# Database access change values
environment:
    - MYSQL_ROOT_PASSWORD
    - MYSQL_USER
    - MYSQL_PASSWORD
    - MYSQL_DATABASE

Warning: Do not change the value of MYSQL_HOST in the .env file.

Then enter this command in the main Directory:

# Run docker-compose
docker-compose up -d

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

GNU GPLv3