/hogwarts-ghosts-bot

Primary LanguagePythonMIT LicenseMIT

BBN (Bot-Be-Named)

Code style: black License: MIT

What is Bot-Be-Named

A Discord bot that interoperates with Google Sheets to smoothen solving puzzle hunts. If you would like to add Bot-Be-Named to your server, please contact @kevslinger#9711 or @Soni#3662 on discord.

Please note that Bot-Be-Named is set up for our own configurations and environment variables, and may not work for yours. Please contact us if you need help setting up an instance of the bot, but we highly recommend asking us for a Bot invite link.

Inviting the Bot to your server

  • Message @kevslinger#9711 or @Soni#3662 on discord to get Bot invite link.

  • Use the Link and add the Bot to your discord server. Note that you need "Manage Server" permission to do that.

  • Use ~about to get a quick guide to the bot, and ~startup for all the commands that will come in very handy for you.

  • In case of any problems, message us on discord or open a new issue on Github

How to install your own instance

Prerequisites -

Note that you may use another Python installer (instead of Pip), Host (instead of Heroku) or Database (instead of Postgresql) but that will require you figuring out the required setup and configuation changes yourself.

Installation

We recommend using virtual environments to manage python packages for our repo. To clone the repo and install dependencies, run the following on the Command Line

#Clone the bot locally
git clone https://github.com/kevslinger/bot-be-named.git
cd bot-be-named
virtualenv venv -p=3.7
#This installs all the python dependancies the bot needs
pip install -r requirements.txt && pre-commit install

The bot uses Heroku Postgres for storing data.

To run the bot locally, you will need a .env file which is used by python-dotenv to load ENV variables. Copy .env.template into .env with

cp .env.template .env

and fill in the blanks in order to get the bot running. You also need to set up the Postgresql database for the bot using (To be finished).

Once you do all that, run

source venv/bin/activate
python bot.py

and the bot will run on the supplied discord token's account.

Hosting

Once you have the bot running and basic commands (like ~help) run properly, you can host it externally. Our instance of the bot is hosted on Heroku

Current Modules

  • Admin for administrator commands (currently, only changing the prefix)
  • Archive for downloading channel/category/server contents into a Zip file
  • Channel Management for cloning, creating, and moving channels
  • Cipher Race Race against the clock decoding ciphers!
  • Discord for discord utility commands (e.g. roles, stats)
  • Error Logging for printing error logs
  • Lookup for Searching the internet via google and wikipedia
  • Music Race Help! Our tunes have been sawed apart and put back incorrectly!
  • Help is an updated help command which automatically pulls docstrings for ~help
  • Perfect Pitch Become a composer and write tunes in mp4
  • Sheets for working with Google Sheets during puzzlehunts
  • Solved for marking Discord Channels as solved, backsolved, solvedish etc.
  • Time for finding the time anywhere in the world
  • Misc for misc. random (fun) commands

Acknowledgements

Big thanks to Jonah Lawrence and his Professor Vector repo for much inspiration and code, specifically on the Channel Management, Error Logging, Help, and Solved modules.

Contributing/Issues

If you find any issues, bugs, or improvements, please feel free to open an issue and/or pull request! Thank you!

Feel free to find me on discord, @kevslinger#9711 with any questions you may have!