General Flow

LIST OF TOOLS REQUIRED

• Python 3.7 or higher - see here for installation guide
• GitHub Desktop (& alternatives & install guide)

GENERAL FLOW

1. Clone the repository
   • See here for instructions
2. Set up venv
   • Option 1: Run setup.bat
     • Note: This script assumes the Python command is associated with Python 3.7+, and not Python 2
   • Option 2: Refer to this section of the Python installation guide
3. Install dependencies
   • See above if you're using venv
   • Else, see this section
4. Obtain bot token
   • See here
5. Configure config.json
   
   • Prior to launching the bot, please navigate to config.json found in the src folder.
   • Here you will find various settings to fill out
   • First you MUST fill out the BOT_TOKEN section by obtaining a bot token from the Discord Developer Portal.
   • The rest of the settings do not need to be filled out for it to work, however feel free to make the changes related to your server
   • If you do not know what you are doing keep "USE_DEFAULT_DB" to true.
     • If it is false, the settings below it would be used for ALL database calls
   • If you configure ADD_ROLE to true, you HAVE to fill out ROLE_TO_ADD which is the role id.
     • You need to have intents enabled for this function to work! See the bot setup guide for how to enable intents
6. Test run
   • Launch the start.bat and select the Global or VENV depending on how you set up Python!
     • Note: It defaults to VENV automatically if you don't input anything