Launch

Instructions to start running the bot

Note: please see the setup page on how to setup your virtual environment prior to use.

Auto-launch Method:

1) Windows:

Run the batch file start.bat

• Follow through the on-screen instructions.
• Note: It defaults to Option A: Using the virtual environment if you don't make a choice in 10 seconds

Note: If you would like the bot to restart itself on crashes, de-comment out lines 26-27 & 34-35.

2) LINUX:

1. Add permissions for the script file.
   • i.e. chmod 755 setup.sh start.sh
   • setup.sh will automatically create a virtual environment with all the right dependencies when it is run (./setup.sh)
   • Note: setup.sh requires pip and MySQL to be installed first!
   • Use either (i.e. MySQL or MariaDB), if you run into errors with setup.sh:
     • sudo apt-get install libmysqlclient-dev or
     • sudo apt-get install libmariadbclient-dev
2. Run
   • i.e. ./start.sh

---

Manual launch Method:

Option A: Using the virtual environment

Please see the setup page on how to setup your virtual environment prior to use.

Command Prompt route:

• Activate the virtual environment using the following command: call venv\scripts\activate.bat
  • Note: You can deactivate the venv by using the command deactivate
• Use the command venv\scripts\python src/Main.py to run

PowerShell route:

• Activate the virtual environment using the following command: venv\scripts\activate
  • Note: You can deactivate the venv by using the command deactivate
• Use the command venv\scripts\python src/Main.py to run

Option B: Using the global environment

Note: You will need to make sure that the global environment is set up such that the dependencies are all resolved.

• python src/Main.py