Skip to content

AbertayHackers/hacksoc-bot

Repository files navigation

Hacksoc Bot

Discord bot for the Abertay Hacksoc Discord Server

Contributions Policy

Contributions from Hacksoc members are welcome!

Please feel free to fork the public repo to create your own development repo. If you wish to add this into the Hacksoc bot dev server, please speak to the secretary.

When deploying:

  • Go to the Discord Developer portal and create a bot. Take note of the token!
  • Clone your local copy of the repository to a development machine (a linux VM is ideal for this, as you can also create a MySQL Database)
  • Create a config/secrets.json file (there is a template provided at config/secrets.json.template). You will need to fill in all of the fields in this template as directed.
  • Update channel/guild IDs in the "env" section of the config/config.json file. A pre-populated version of this already exists for the official dev server (speak to the secretary about getting access)
    • For dev, please export an environment variable DEV=/path/to/config/file, rather than overwriting the original
  • Initialise your MySQL database locally by running mysql < config/init.sql -- make sure to update the password!.
  • Run the main.py script.
  • Your bot should now be deployed!

Contribution Thanks

A big thank you to @CyberSophi for the Discord Portal design, and to @Samiser for taking the time to implement the design for web.

To Do:

  • Add Multi-language support
  • Set up decent logging
  • Add AGM Commands