Prerequisites
This guide assumes that a development environment with all required dependencies has been set-up. Check the “hacking on score” guide for more information on how to do that.
Choosing the plug-in API to use
ossia score provides two plug-in APIs:
Avendish API
A simple API that can be used to implement quick audio / midi / control effects and generators in a single file.
This is the API to use if you want to provide for instance a new audio or video processor to use as an ossia object.
The documentation of the Avendish API is available here: note in particular that the plug-ins written with Avendish are independent from ossia score and can also be exported to other systems, such as VST, etc. ossia score is however the implementation that provides most of the features :-)
Read the score avendish plug-in documentation to get started.
Score API
A more advanced API that allows to customize pretty much every aspect of the software, but requires more work.
The major part of the software is built with that API: every process in score comes from plug-ins. These plug-ins are located in the score git repository.
The addon tutorial is an example of usage of the score API to showcase its capabilities. It is documented here.
To develop new plug-ins that way, we provide a set of Github templates. Simply create a repository from the template, and follow the steps in the README.