Skip to content

Installation Guide🔗

Donwloads🔗

Required

Optional

Installing FoxDot🔗

Follow the installation instructions for your downloads of Python and SuperCollider. When installing Python on Windows, click yes when asked if you want to add Python to your system path and yes if you want to install pip – this is used for automatically downloading/installing Python libraries such as FoxDot.

Install the latest version of FoxDot from the Python Package Index using pip from your command line (command prompt in Windows, terminal in MacOS and Linux) by executing:

pip install FoxDot

Please note, if you have Python 3 installed, the program might be called pip3, which helps discern between pip for Python 2 and 3.

Alternatively, you can build from the source on GitHub and keep up to date with the development version:

git clone https://github.com/Qirky/FoxDot.git
cd FoxDot
python setup.py install

Open SuperCollider and install the FoxDot Quark (this allows FoxDot to communicate with SuperCollider) by entering the following in the editor and pressing Ctrl+Return; which "runs" a line of code:

Quarks.install("FoxDot")

Recompile the SuperCollider class library by going to Menu → Language → Recompile Class Library or pressing Ctrl+Shift+L.

If you can't install git on your machine, you can download a startup file, called FoxDot.scd. Open this in SuperCollider and evaluate the code by pressing Ctrl+Return.

Installing SC3 Plugins (optional)🔗

The SC3 Plugins are a collections of classes that extend the already massive SuperCollider library. Some of these are used for certain "effects" in FoxDot (such as bitcrush) and will give you an error in SuperCollider if you try to use them without installing the plugins.

Once downloaded place the folder into your SuperCollider "Extensions" folder and then restart SuperCollider. To find the location of the "Extensions" folder, open SuperCollider and evaluate the following line of code:

Platform.userExtensionDir

This will display the location of the "Extensions" folder in the SuperCollider "post window", usually on the right hand side of the screen. If this directory doesn’t exist, just create it and put the SC3 plugins in there and restart SuperCollider. When you next open FoxDot, go to the "Language" drop-down menu and tick "Use SC3 Plugins". Restart FoxDot and you’re all set!

Starting Up🔗

Open SuperCollider and evaluate the following (this needs to be done before opening FoxDot):

FoxDot.start

SuperCollider is now listening for messages from FoxDot. To start FoxDot from the command line just type:

python -m FoxDot

The FoxDot interface should open up and you’re ready to start jamming! Check out the Getting Started docs for some useful tips on getting to know the basics of FoxDot. Happy coding!