Extension plugins for the SuperCollider3 audio synthesis server. These third-party plugins provide additional synthesis, analysis, and other capabilities for the sound server.
C C++ HTML SuperCollider CMake Matlab
Latest commit 420ad65 Nov 28, 2016 @joslloand joslloand Update README: inline warnings
Note @telephon issue fix

README.md

SC3-plugins

This repository contains the community collection of unit generator plugins for SuperCollider. An installation extends the functionality of SuperCollider by additional UGens that run on scsynth, the SuperCollider audio synthesis server.

Note: Extensions for the SuperCollider programming language are something structurally different. They are collected within the Quarks packaging system.

To learn how to write your own plugins, see example-plugins and the "Writing UGens" helpfile.

For community discussion and support see the SuperCollider mailing lists and the github issue tracker.

Download

Compiled releases are available from the github release page. For older versions (2013). see the sourceforge project page.

To compile from source (see below), either download a tarball or clone this repository:

$ git clone --recursive https://github.com/supercollider/sc3-plugins.git

Binary install

Copy the contents of the tarball/dmg to your SuperCollider extensions folder. You can find out which one that is by evaluating

Platform.userExtensionDir

from within SuperCollider. Alternatively, you may install the extensions system-wide by copying to

Platform.systemExtensionDir

Compile from source

As SuperCollider, the sc3-plugins collectiton uses the cmake build system for configuration and compilation. Follow the steps below to compile and install the collection.

Make a directory for the cmake build files:

sc3-plugins/$ mkdir build && cd build
sc3-plugins/build/$ cmake -DSC_PATH=/path/to/sc3source/ ..

If no SC_PATH is provided the build system assumes the SuperCollider include files in /usr/include/SuperCollider/.

sc3-plugins/build/$ make
sc3-plugins/build/$ make install

On OSX, the plugins will end up in sc3-plugins/build/SC3plugins. Copy the SC3plugins folder to you Extensions folder (you find out which one that is by evaluating Platform.userExtensionDir from within SuperCollider).

WARNING: on OSX, if you want to install into CMAKE_INSTALL_PREFIX, you have to specify it by disabling the IN_PLACE_BUILD cmake option which defaults to ON (see below).

Cmake Options

  • Set install target
    • (default on linux /usr/local)
    • sc3-plugins/build/$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..
  • Install in cmake build folder instead of CMAKE_INSTALL_PREFIX
    • (OSX ONLY, default=ON)
    • sc3-plugins/build/$ cmake -DIN_PLACE_BUILD=ON
  • Build the plugins as quarks
    • (default 'OFF')
    • sc3-plugins/build/$ cmake -DQUARKS=ON ..
  • Build supernova-plugins
    • (default 'OFF')
    • sc3-plugins/build/$ cmake -DSUPERNOVA=ON ..
  • Print all cmake options
    • sc3-plugins/build/$ cmake -L ..

Starting over

If something went wrong and you want to start from scratch, delete everything in the build directory that you made:

sc3-plugins/build/$ make uninstall # only if you did `make install` before
sc3-plugins/build/$ rm -r *

Adding plugins to the repository

A SuperCollider plugin is a collection of UGens (and their supporting files) with a shared prefix in their name. If you add a new plugin, please keep to the following pattern:

  1. Add a folder in the source directory named <prefix>UGens where prefix means whichever standard pattern in the file name you have for your UGens. All source files go into this directory and its subdirectories.
  2. SuperCollider-specific files (.sc|.schelp|...) should be located in a subdirectory named sc.
  3. If your plugin makes use of external libraries that should be part of the sc-plugins sources (e.g. via git-submodule), add them to sc3-plugins/external_libraries/. As an example, the GlitchUGens plugin directory lists as:
    • source/GlitchUGens/GlitchUGens.cpp
    • source/GlitchUGens/sc/GlitchUGens.sc
    • source/GlitchUGens/sc/HelpSource/Classes/GlitchBPF.schelp
    • source/GlitchUGens/sc/HelpSource/Classes/GlitchBRF.schelp
    • source/GlitchUGens/sc/HelpSource/Classes/GlitchHPF.schelp
    • source/GlitchUGens/sc/HelpSource/Classes/GlitchRHPF.schelp
  4. Add your folder to the PLUGIN_DIRS list in sc3-plugins/source/CMakeLists.txt.
  5. For the Quark-installable option, there is a SuperCollider script called Generate_Quark.scd in sc3-plugins/quarks/. Evaluating it indexes the base directory of the extensions for each UGen, and Help-file in each plugin directory. It then creates a help file for your plugin that lists all classes and help files, as well as a .quark file for your plugin in the build/DIRECTORY folder.

Packaging

How to create a DiskImage (OSX)

To create an OSX DiskImage, follow these steps on an OSX machine:

sc3-plugins/$ mkdir build && cd build
sc3-plugins/build/$ cmake -DSC_PATH=/PATH/TO/SC -DOSX_PACKAGE=1 ..
sc3-plugins/build/$ make && make install

The DiskImage will be generated in ./sc3-plugins/build/build_osx containing

  • a License.txt,
  • this README.txt, and
  • the SC3plugins folder.
  • Note: the quarks DIRECTORY-folder is also included by default.

How to create a tarball/zip-file

sc3-plugins/$ mkdir build && cd build
sc3-plugins/build/$ cmake -DSC_PATH=/PATH/TO/SC ..
sc3-plugins/build/$ cpack -G [TGZ|ZIP] # choose your package format

The package will end up in sc3-plugins/build.

List of plugins

An auto-generated list of what plugins are available in this repository, linking to the autogenerated helpfiles: