Installation & Setup

Heroku users: use this install guide

Required software to run the bot

• Python 3.5.3 + (scroll to the bottom). Python 3.7 is not supported.
  • When installing, make sure to select "Add to PATH" on Windows.
• Git.
  • When installing, make sure this is selected on Windows.
  • Leave everything else as is.

Grab your token from Discord

• On Discord, do Ctrl + Shift + i on Windows or Cmd + Option + i on Mac in that order.
• Go into the Network tab, and wait for some requests to show up. If there are none, create one by typing in any channel.
• Find a request that has an authorization key in the request headers. Screenshot of network tab. Grab the value given for authorization. This is your token.
• Don't give this out to anyone! You'll need this token soon.

Note: If you change your password or enable/disable two-factor authentication, your token will change. If this happens, and you've already set up the bot, you'll need to change the token by editing the config.json file under settings.

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).

• Mac/Linux: Navigate to the bot's folder in terminal/shell and run: bash run_linuxmac.sh

  • If it still 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.

Note: Running as administrator/with sudo should only be necessary for the first run. When all requirements are installed, this won't be necessary anymore. It is strongly encouraged to run the bot normally now.

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 and modifications.

{
    "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.

No need to worry about the other fields right now, they can be added/modified from within the bot and don't restrict any commands.