Guide for OSX

OS X Yosemite and above

Some information may not be applicable to older versions of OS X.

Introduction

Installing the bot on OSX requires the downloading of several libraries. Homebrew, Python, a text editor, and other software/dependecies are required to run the MusicBot. This guide will show tell you each of those things you need to install to download the bot and its dependencies.

1: Dependencies

1.a: Python

ClickHere to start downloading Python3.5.2. After downloading, open the python-3.5.2-macosx10.6.pkg and complete installation to your computers harddrive.

1.b: Other dependencies

The bot requires other software installed on your OS X machine. You should run the following commands in Terminal's console in order. Note: When running the xcode-select --install a dialog bog will open asking if you want to install xcode-select; select install and finish the installation then continue on with the other commands with in Terminal.app.

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew update
xcode-select --install
brew install git
brew install ffmpeg
brew install opus
brew install libffi
brew install libsodium

2: Clone

To get the latest version of MusicBot, run the following commands in Terminal:

cd desktop
git clone https://github.com/SexualRhinoceros/MusicBot.git MusicBot -b master 
cd    

cd'ing to the desktop allows you to quickly find your MusicBot folder as it places the folder directly on your desktop.

3: Configure

At this point you should create a bot account and add it to your server.

Inside the bot's folder is another folder called config. Open it, and then open the example_options.ini file. This is the file containing the bot's settings. All options are explained in the file. Make sure you save the file as options.ini after editing. If you need help, read the configuration page.

4: Terminal Permissions

In order for Terminal.app to run the .command files needed for the bot you will need to do the following:

In Terminal.app type the command below followed by a space:

chmod +x 

Click and drag the file update_macdeps.command into terminal then press RETURN. Repeat the above for the runbot_mac.command file. You should then be able to double-click the command files to run the bot.

Example:

5: Run

In the main folder (called MusicBot), double-click update_macdeps.command to install the required Python dependencies. After it is finished, you can close the window and then double-click runbot_mac.command to run the bot.

If you close the Terminal, your bot will stop working. This window is required to be open for the bot to run. The bot will also stop if you turn your computer off, sleep, or hibernate it. To avoid these issues, you can buy a dedicated server.