Installation & Setup

Required software to run the bot

• Python 3.5.2 or higher (scroll to the bottom).
  • When installing, make sure to select "Add to PATH" on Windows.
  • Mac users: Avoid Python 3.6 if possible, it may not work.
• 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.

Setup

• Download the zip from the main page. The download is located here in case you don't see it.
• Extract the contents of the zip and place the folder somewhere easily accessible for you.
• Go into the settings folder in the bot folder and open the file called config.json It should look like this:

{
    "token" : "",
    "cmd_prefix": ">",
    "customcmd_prefix": ".",
    "bot_identifier": ":robot:"
}

• Paste your token in the token field. It should look like this: "token" : "Makljjfkaljfd.lakCJlkjadflaksjdhfkj", but with your token.
  • Make sure there are no double quotes around the token. Just a single set of quotes. Also, for Mac users: you may need to disable smartquotes. Just make sure quotes in the json look like this: "
• Change the other values if you want.
  • cmd_prefix and customcmd_prefix - the prefix for in-built commands and custom commands respectively. Prefixes can be more than one character. You may set the same prefix for both but be careful not to make a custom cmd with the same name as an in-built. Note: \ is not supported as a prefix
  • bot_identifier - a word/message/emote the bot will add to the beginning of every message it sends (except embeds and replies to quick cmds). Make it empty if you don't want one. Note: \ is not supported as a prefix
• Save the file.

Starting the bot

• 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). An anti-virus may warn you when you try to run it but let it pass. If everything in the config is setup properly you should login fine. If you have a weak internet connection, the bot could take several minutes to log in. 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. Alternatively, 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.
• When it shows "logged in as" you are good to go. 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.

---

Optional Setup

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" : "",
    "mal_username" : "",
    "mal_password" : ""
}

• 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.
• mal_username and mal_password - MyAnimeList username and password which is required in order to do a MAL search. This is required in order to use the MAL API to grab anime/manga information and is not used for anything else. A normal MAL account will suffice.

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.