Skip to content

Installing from Source Code

Kyle Neideck edited this page Oct 9, 2022 · 5 revisions
⚠️ You need to install Xcode for this and it's currently a 12 GB download.

Building and installing Background Music from source is pretty simple but can be a little tricky if this is your first time. If you just want to install the latest version, you might want to check for a recent snapshot release first.

Please bear in mind that Background Music is in the very early stages of its development and has a lot of bugs. It hasn't been thoroughly tested yet and shouldn't be used for anything important.

In the unlikely event that it breaks something on your computer, please create an issue.

Installation

Download Location

  • Unzip the file and open the folder.

  • Open Terminal.app (found in the Mac Utilities folder at /Applications/Utilities)

  • In Terminal, type cd and the path to the folder you have just unzipped and hit return (this may be in your downloads folder, if so, the path should be as follows):

cd /Users/YourHomeFolderName/Downloads/BackgroundMusic-master

The "YourHomeFolderName" must be replaced with your own home folder name! You can find this by navigating to /Users and looking for the name with a house icon next to it. (Likely your own name!)

  • Type the following command and then hit return:

/bin/bash build_and_install.sh

  • You will be prompted to continue, type y and then hit return. You may also be prompted for your password. Enter it and hit return.

AT THIS TIME YOU MAY BE PROMPTED WITH AN ERROR

This install requires that you have Xcode installed on your computer and the Command-Line Developer Tools installed. The error may look like this:

ERROR: The Xcode Command Line Tools don't seem to be installed on your system. If you have Xcode installed, you should be able to install them with xcode-select --install If not, you'll need to install Xcode (~9GB), because xcodebuild no longer works without it. Looking for Xcode... It looks like you have Xcode installed to /Applications/Xcode.app

  • If you have Xcode installed (in the example above, the last few lines note whether you do or not), you will need to open a new terminal window (Type Command+N to open a new window) and then type:

xcode-select --install

  • You will be able to download the tools using this command. This may take a few minutes.

  • After this install is done, you can return to your other Terminal window and type the following command and hit return:

/bin/bash build_and_install.sh

  • Then type y to accept and continue. You may also be prompted for your password. Enter it and hit return.

To download Xcode, search for it in the Mac App Store, or download it.


  • At this time the script will run and you will see its progress in the Terminal window. When "Done." is displayed, it should fully function.

killall coreaudiod

At times the install may require one additional command to be used if it does not work immediately. Simply type the following command and hit enter: sudo launchctl kickstart -kp system/com.apple.audio.coreaudiod || sudo killall coreaudiod. Then open the Sound panel in System Preferences, go to the Output tab and change your audio device at least once, leaving it set to the device you want to use. (This will be something like "Built-in Audio", "Internal Speakers" or "Headphones" for most people.)

After this, launch Background Music from your Applications folder, and you're ready to go!