From 35c3f09a60090bd18173f36e8522f8494dfc37ca Mon Sep 17 00:00:00 2001 From: falkTX Date: Sat, 4 Dec 2021 20:22:12 +0000 Subject: [PATCH] Describe the 3 available variants Signed-off-by: falkTX --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 826ce68..f3c1a22 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,30 @@ A VST3 version is in progress, already part of the build but still experimental. **The project should be considered in alpha state at the moment.** +## Plugin variants + +Cardinal provides 3 plugin variants - "main", Synth and FX. +They are all equivalent in performance and behaviour, with only the IO and metadata that changes. +This is because some hosts are very strict on which plugins are allowed as instruments vs FX, so separate variants of the same plugin are needed. + +All variants have 2 audio outputs and MIDI support. + +### Main + +This variant provides 2 audio inputs and outputs and 8 CV inputs and outputs. + +NOTE: Due to VST2 format not supporting CV ports, this variant is not available for VST2. + +### Synth + +This variant provides 2 audio inputs and outputs, no CV ports. +Plugin type is tagged as "instrument". + +### FX + +This variant provides 2 audio inputs and outputs, no CV ports. +Plugin type is tagged as regular "effect". + ## Screenshots Because people will ask for it. It is, well... Rack.