brian/Cardinal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update some docs

Browse source 
Signed-off-by: falkTX <falktx@falktx.com>
This commit is contained in:
falkTX 2023-07-08 13:42:06 +02:00
parent d44eed4e88
commit 9b329eeb15
No known key found for this signature in database
GPG key ID: CDBAA37ABC74FBA0
2 changed files with 13 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/DIFFERENCES.md
View file

@ -35,13 +35,13 @@ Bellow follows a list of features comparing the official plugin to Cardinal.
| Synth plugin variant | 16 ins, 16 outs | 2 ins, 2 outs | | | Synth plugin variant | 16 ins, 16 outs | 2 ins, 2 outs | |
| FX plugin variant | 16 ins, 16 outs | 2 ins, 2 outs | | | FX plugin variant | 16 ins, 16 outs | 2 ins, 2 outs | |
| Raw-CV plugin variant | Unsupported | 8 audio IO + 10 CV IO | Available in JACK, LV2 and VST3 formats, not possible in AU and VST2 | | Raw-CV plugin variant | Unsupported | 8 audio IO + 10 CV IO | Available in JACK, LV2 and VST3 formats, not possible in AU and VST2 |
| Arbitrary parameter automation | Yes | No | | | Arbitrary parameter automation | Yes | No (*) | Static 24 automatable params, use Host Params/Map modules to map them to module parameters |
| Integrated plugin host | No, Host payed separately | Yes, using Carla or Ildaeil | | | Integrated plugin host | No, Host payed separately | Yes, using Carla or Ildaeil | |
| Host sync/timing | Using MIDI signals | Using dedicated module | | | Host sync/timing | Using MIDI signals | Using dedicated module | |
| Linux/X11 event handling | Runs on 2nd thread | Runs on main/GUI thread | | | Linux/X11 event handling | Runs on 2nd thread | Runs on main/GUI thread | |
| v1 module compatibility | No | No, but with less restrictions | Module widgets can load resources at any point | | v1 module compatibility | No | No, but with less restrictions | Module widgets can load resources at any point |
| Online phone-home | Yes | No | Online access is strictly forbidden in Cardinal | | Online phone-home | Yes | No | Online access is strictly forbidden in Cardinal |
| Proper dark theme | No, only room brightness | Yes | All dark panel variants have explicit permission when required | | Proper dark theme | WIP | Yes | All dark panel variants have explicit permission when required |
| Proper Linux headless mode | No, always requires X11 | Yes | | | Proper Linux headless mode | No, always requires X11 | Yes | |
Additionally, Cardinal contains the following built-in modules not present in the official plugin or standalone: Additionally, Cardinal contains the following built-in modules not present in the official plugin or standalone:
@ -50,6 +50,7 @@ Additionally, Cardinal contains the following built-in modules not present in th
* Mog (never updated to v2) * Mog (never updated to v2)
* mscHack (never updated to v2) * mscHack (never updated to v2)
* rackwindows * rackwindows
* AIDA-X
* Audio File * Audio File
* Audio to CV Pitch converter * Audio to CV Pitch converter
* Carla Plugin Host * Carla Plugin Host

14
docs/FAQ.md
View file

@ -43,10 +43,16 @@ where we discuss possible modules to include.
## Changes are lost on restart ## Changes are lost on restart
This is intentional. This is intentional. Unlike VCV Rack, Cardinal does not automatically save.
Cardinal is meant to be a self-contained plugin, and as such it does not save any files whatsoever.
This includes user preferences (like list of favourites) or last used project. Also, different variants (main vs FX vs Synth) use different files for saving their settings, so there might be some confusion arising from that.
As a plugin, the state will be saved together with the host/DAW project. But on the other hand this allows you to have a different template and other defaults per variant, which is quite handy.
## Scaling/High-DPI not working properly, how to fix it?
Cardinal, using [DPF](https://github.com/DISTRHO/DPF), will try to automatically detect the system scaling and adjust to that.
On cases where that does not work you can set `DPF_SCALE_FACTOR` environment variable to a value of your choosing in order to force a custom scale factor.
Note that this applies to all DPF-based plugins and not just Cardinal.
## On BSD/Linux/X11 the menu item "Save As/Export..." does nothing ## On BSD/Linux/X11 the menu item "Save As/Export..." does nothing