159
edits
Changes
Jump to navigation
Jump to search
Creating a new Zynthian Synth Engine (view source)
Revision as of 09:19, 14 February 2018
, 09:19, 14 February 2018Created page with "= Creating a Zynthian engine = == Prerequirements == Before starting to build your own engine you have to satify some facts: * You need to know how to program in [https://www...."
= Creating a Zynthian engine =
== Prerequirements ==
Before starting to build your own engine you have to satify some facts:
* You need to know how to program in [https://www.python.org Python]3.
* Some ideas about [https://git-scm.com/ Git], [https://github.com/ GitHub] (including an account) and how to clone, branch, pull, creating push requests are very useful.
* You should have some experience with using Zynthian to understand the workflow.
* You should have some ideas about working with Linux/Unix.
Before you start, check if your desired software for the engine would work with Zynthian:
* You need a binary/LV2-plugin compiled for the Raspberry (ARM7-architecture - '''NOT i386 or AMD'''!!!)
* If you can get the source-code: nice! You have to write an installation script for compiling and installing, so you also need knowledge about shell-programing and compiler-tools (gcc, make, ...)
* '''Take a look at the license!!!''' It makes no sense if you write lots of code and don't find a way to license the software for working with Zynthian. Perhaps you also have to think about a way to get a license-key for your software into the system.
* Your software does not need a GUI. The controlling of your software should completely done via command-line/config-files/[https://en.wikipedia.org/wiki/Musical_Instrument_Digital_Interface MIDI]/[https://en.wikipedia.org/wiki/Open_Sound_Control OSC]. If there is only a GUI control it may be impossible to write an engine.
* VST instruments are currently not supported! The only plugin format you can use is currently LV2 (inside MOD-UI engine).
Ok, if you have read until this line and you are not already shocked from the prerequirements you should share your idea with the [https://discourse.zynthian.org/ Zynthian-Forum]. Perhaps some more hints and spoilers can help for your project.
== Write the engine ==
=== The filesystem structure ===
=== Files to touch/generate ===
=== How to test ===
=== How to get the software into Zynthian(-master) ===
== Prerequirements ==
Before starting to build your own engine you have to satify some facts:
* You need to know how to program in [https://www.python.org Python]3.
* Some ideas about [https://git-scm.com/ Git], [https://github.com/ GitHub] (including an account) and how to clone, branch, pull, creating push requests are very useful.
* You should have some experience with using Zynthian to understand the workflow.
* You should have some ideas about working with Linux/Unix.
Before you start, check if your desired software for the engine would work with Zynthian:
* You need a binary/LV2-plugin compiled for the Raspberry (ARM7-architecture - '''NOT i386 or AMD'''!!!)
* If you can get the source-code: nice! You have to write an installation script for compiling and installing, so you also need knowledge about shell-programing and compiler-tools (gcc, make, ...)
* '''Take a look at the license!!!''' It makes no sense if you write lots of code and don't find a way to license the software for working with Zynthian. Perhaps you also have to think about a way to get a license-key for your software into the system.
* Your software does not need a GUI. The controlling of your software should completely done via command-line/config-files/[https://en.wikipedia.org/wiki/Musical_Instrument_Digital_Interface MIDI]/[https://en.wikipedia.org/wiki/Open_Sound_Control OSC]. If there is only a GUI control it may be impossible to write an engine.
* VST instruments are currently not supported! The only plugin format you can use is currently LV2 (inside MOD-UI engine).
Ok, if you have read until this line and you are not already shocked from the prerequirements you should share your idea with the [https://discourse.zynthian.org/ Zynthian-Forum]. Perhaps some more hints and spoilers can help for your project.
== Write the engine ==
=== The filesystem structure ===
=== Files to touch/generate ===
=== How to test ===
=== How to get the software into Zynthian(-master) ===