Skip to content
Discord bot handling the management of the MUN Computer Science Society Discord server.
Python Dockerfile
Branch: master
Clone or download
jackharrhy Merge pull request #5 from MUNComputerScienceSociety/better-readme-n-…
…ping

Add ping plugin, cleanup and make README more verbose
Latest commit 93b33fc Oct 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config/prometheus
plugins
.dockerignore
.drone.yml
.env.dist
.gitignore
Bot.py
Dockerfile
Globals.py
LICENSE
Plugin.py
README.md
docker-compose.yml
requirements.txt

README.md

Automata

Build Status

Discord bot handling the management of the MUN Computer Science Society Discord server.

Running locally

  1. Clone the project by running git@github.com:MUNComputerScienceSociety/Automata.git, and change into the directory by running cd ./Automata
  2. Create the directory mounted_plugins within the project by running mkdir ./mounted_plugins
  3. Copy .env.dist to .env
  4. Fill out the required information in the .env
    • At the moment, the only required environment variable required is AUTOMATA_TOKEN, which is a Discord token, which you can see how to get here
  5. Create the network web by running docker network create web
  6. Start the containers by running docker-compose up -d

Developing your own plugins

Automata is built around the discord.py framework, therefore the plugins make heavy use of its decorators to abstract most of the complexity behind the scenes.

  1. Create the folder mounted_plugins if it doesn't already exist.
    • plugins is baked into the image when it is built, so editing files there won't have an effect
  2. Create a new plugin within the mounted_plugins folder
    1. Create a new Jigsaw plugin manifest
      • You can use plugins/Ping/plugin.json as an example
    2. Create a new plugin
      • You can use plugins/Ping/__init__.py as an example
  3. Start the bot using the instructions from Running locally

When you make changes to your plugins, restart the Automata container using docker-compose restart automata

Developing the bot core and built-in plugins

  1. Edit the docker-compose.yml, replacing the image: muncs/automata line for the automata container with build: .
  2. Edit the bot core or the plugins as you wish
  3. Start the container, forcing a rebuild of the image using docker-compose up -d --build

Container responsibilities

Automata is comprised of a number of containers, each with distinct responsibilities. Their responsibilities are as follows:

Container Responsibilities
automata The Discord bot itself.
mongo A MongoDB server used to provide persistent data storage to the automata container.
prometheus A Prometheus server used to collect statistics from the automata container.
grafana A Grafana instance that collects data from prometheus and uses them to produce graphs.
cadvisor Exports stats on running docker containers to prometheus
mongodbexporter Exports stats from mongo to prometheus
You can’t perform that action at this time.