Skip to content

Installation Guide

Blake C edited this page Apr 18, 2024 · 12 revisions

How to install and set up Creativity-Optional

Installation

Prerequisites:

  • Docker Desktop
  • Python 3

Downloading

You can retrieve the docker image from docker hub Make sure you have the right version for your operating system.

You will also need a local client which you can grab from the latest release or build your own. See contributing to this project for more information.

With everything downloaded, you should be ready to use the application.

Setting Up

When running, you will first need to start the docker image using your preferred method. Once your creativity-optional server is running you will need to start your local application. The local application and the creativity-optional image need to be on the same local network, but not necessarily the same computer.

With both running you are done!

Setup on MacOS

The MacOS version of CO uses PyAudio (because SoundCard only works on Linux and Windows RIP) The downside of this is that PyAudio doesn't naively support loop-back, so we have to get it ourselves. Our current solution is to use BlackHole, a popular loop-back driver

Setting up the virtual environment

To setup the virtual environment on MacOS, run the following command:

source .venv/bin/activate

Installing BlackHole

install the desired BlackHole driver by running: ./brew-installer.sh

this will automatically install the desired 2 driver version of BlackHole

Creating the Loopback system

Follow this tutorial from the BlackHole GitHub to set up the Loopback with a Multi-Output Device:

https://github.com/ExistentialAudio/BlackHole/wiki/Multi-Output-Device

Tested Browsers that don't work without changing settings:

Safari, Brave

Tested Browsers that work:

Chrome, Firefox