OmniSynth Developer

Sound engine for playing, creating, and sequencing synthesizers.

Installation Guide

Follow the instructions below that correspond to your environment.

Mac / Linux / Windows

1. Install Supercollider

   • Visit the official SuperCollider downloads page to install the correct build for your OS.

2. Install OmniSynth

   1. Clone OmniSynth:

      git clone git@github.com:omniaura/omnisynth-dev.git

   2. Install the latest OmniSynth Wheel:

      pip install omnisynth-{x.y.z}-py3-none-any.whl

3. Running OmniSynth:

   1. Run main.py from omnisynth-dev/ root directory:

      python main.py

4. Building OmniSynth Wheel from source (optional)

   1. Navigate into omnisynth/
   2. Run python -m pip install --upgrade build
   3. Run python -m build. You should see the output `Successfully built omnisynth-{x.y.z}.tar.gz and omnisynth-{x.y.z}-py3-none-any.whl`*
   4. Navigate into dist/
   5. There should be file with the name omnisynth-{x.y.z}-py3-none-any.whl. Run pip install omnisynth-{x.y.z}-py3-none-any.whl
   6. You should see the output "Successfully installed omnisynth-{x.y.z}" in the console.

   ** {x.y.z} correspond to the current OmniSynth version

RaspberryPi

1. Install Raspbian OS

   • We recommend the latest 2019 version of Raspbian OS to avoid installing Pulseaudio, a sound driver that messes with Supercollider's Jack interface.

2. Install SuperCollider

   • Follow the official build instructions from SuperCollider. Do not run "sudo apt-get dist-upgrade" or you will accidentally install Pulseaudio.

3. Install OmniSynth

   1. Clone OmniSynth:

      git clone git@github.com:omniaura/omnisynth-dev.git

   2. Install the latest OmniSynth Wheel:

      pip install omnisynth-{x.y.z}-py3-none-any.whl

   3. Install required Python packages for Kivy GUI:

      pip3 install Kivy==2.0.0
      pip install kivy-garden
      garden install graph
      garden install matplotlib

4. Running OmniSynth

   1. Set the DISPLAY port:

      export DISPLAY=:0.0

   2. Start the GUI from root omnisynth-gui/ directory:

      cd omnisynth-gui/
      python3 main.py