Installation & Setup

Heroku users: use this install guide

Required software to run the bot

• Python 3.5.2 + (scroll to the bottom).
  • When installing, make sure to select "Add to PATH" on Windows.
  • Some people have experienced issues with Python 3.6. Avoid if possible.
• Git.
  • When installing, make sure this is selected on Windows.

Grab your token from Discord

• On Discord, do Ctrl + Shift + i on Windows or Cmd + Shift + i on Mac in that order.
• Go here to get your token. Don't give this out to anyone! You'll need this token soon.

Starting the bot

• Download the bot from the main page (here's where you download) and unzip the folder. Alternatively, you can just download either run.bat (windows) or run_linuxmac.sh (mac/linux), put the file in an empty folder, then run to download all files.

• Windows: Double click run.bat to start the bot. If you get a "permission denied" message, try running as administrator (and make sure git is installed to the admin account). If it refuses to recognize that Git is installed or gets stuck on checking requirements for too long, try running as administrator.

• Mac/Linux: You should be able to double click run_linuxmac.sh to start the bot on Mac. If that doesn't work (error with "task is pending"), navigate to the bot's folder in terminal/shell and run: bash run_linuxmac.sh

  • If the bash script isn't working for you, try sudo -H pip install -r requirements.txt (only need to do it the first time) and then try running the bash script again.
  • Mac users: you may need to install XCode. In terminal, type xcode-select --install

• Paste your token when prompted. A few more setup options will be prompted. Once the setup is over, the bot should start up. If you have a weak internet connection, the bot could take several minutes to log in. When it shows "logged in as {username}" you are all set! Screenshot.

Optional: Set the bot to run when you start up your computer so you don't have to remember to run it. Instructions for Windows.

Updating the bot when a new version comes out

The respective scripts will ask you when you start the bot if you want to update and will apply the updates for you. Alternatively, you can use the >stats command on discord to check if you are behind and update with the >update command.

Optional Setup (Google Image Search)

This is the optional_config.json file in the settings folder. These are additional parts that are not required to get the bot running but do provide some nice features.

{
    "google_api_key" : "",
    "custom_search_engine" : ""
}

• google_api_key and custom_search_engine need to be obtained from Google. See the Google API section for instructions. This allows for image search with the >i command as well as smarter >mal search.