Add screenshots and some plugin details
Signed-off-by: falkTX <falktx@falktx.com>
This commit is contained in:
parent
eeac63177c
commit
296aa4d814
3 changed files with 61 additions and 1 deletions
62
README.md
62
README.md
|
@ -6,14 +6,25 @@
|
||||||
|
|
||||||
This is a [DPF-based](https://github.com/DISTRHO/DPF/) plugin wrapper around [VCV Rack](https://github.com/VCVRack/Rack/),
|
This is a [DPF-based](https://github.com/DISTRHO/DPF/) plugin wrapper around [VCV Rack](https://github.com/VCVRack/Rack/),
|
||||||
using its code directly instead of forking the project.
|
using its code directly instead of forking the project.
|
||||||
The target is to have a proper, self-contained, fully free and open-source plugin version of Rack.
|
The target is to have a **proper, self-contained, fully free and open-source plugin version of Rack**.
|
||||||
See [project overview](doc/OVERVIEW.md) document for an overview on how the project source code is structured.
|
See [project overview](doc/OVERVIEW.md) document for an overview on how the project source code is structured.
|
||||||
|
|
||||||
|
Cardinal contains Rack, some 3rd-party modules and a few internal utilities all in a single binary.
|
||||||
|
It does not load external modules and does not connect to the official Rack library/store.
|
||||||
|
|
||||||
Because it is using DPF, Cardinal already supports LV2 and VST2 with an extra JACK standalone mode if self-compiled.
|
Because it is using DPF, Cardinal already supports LV2 and VST2 with an extra JACK standalone mode if self-compiled.
|
||||||
A VST3 version is in progress, already part of the build but still experimental.
|
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.**
|
**The project should be considered in alpha state at the moment.**
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|
Because people will ask for it. It is, well... Rack.
|
||||||
|
But a couple of modules background's have their colors flipped, because damn we want proper dark mode!
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
## Current status
|
## Current status
|
||||||
|
|
||||||
Most of the features already work, you can assume things work in general except when stated otherwise.
|
Most of the features already work, you can assume things work in general except when stated otherwise.
|
||||||
|
@ -29,6 +40,55 @@ Currently the following features are known NOT to work:
|
||||||
If you want to try this out early, checkout the GitHub actions tab.
|
If you want to try this out early, checkout the GitHub actions tab.
|
||||||
There is absolutely no warranty, use at your own risk and all that...
|
There is absolutely no warranty, use at your own risk and all that...
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Cardinal is licensed under GPLv3+, see [LICENSE](LICENSE) for more details.
|
||||||
|
An overview of the included code and linked submodules can be seen [here](doc/LICENSES.md).
|
||||||
|
|
||||||
|
## Included modules
|
||||||
|
|
||||||
|
At the moment the following 3rd-party modules are provided:
|
||||||
|
|
||||||
|
- AS
|
||||||
|
- Amalgamated Harmonics
|
||||||
|
- Animated Circuits
|
||||||
|
- Aria Salvatrice
|
||||||
|
- Atelier (*)
|
||||||
|
- Audible Instruments
|
||||||
|
- Befaco
|
||||||
|
- Bidoo (*)
|
||||||
|
- Bogaudio
|
||||||
|
- cf
|
||||||
|
- DrumKit
|
||||||
|
- E-Series
|
||||||
|
- Fundamental
|
||||||
|
- Grande
|
||||||
|
- Impromptu
|
||||||
|
- JW-Modules
|
||||||
|
- MindMeld
|
||||||
|
- mscHack
|
||||||
|
- Rackwindows
|
||||||
|
- repelzen
|
||||||
|
- Valley
|
||||||
|
- ZZC (*)
|
||||||
|
- ZetaCarinae
|
||||||
|
|
||||||
|
(*) Might be removed soon due to license conflicts
|
||||||
|
|
||||||
|
Additionally Cardinal provides its own modules for DAW/Host automation, time position and internal plugin hosting.
|
||||||
|
|
||||||
|
### Restrictions
|
||||||
|
|
||||||
|
Being an open-source project, all included 3rd-party modules must be opensource and have a GPLv3+ compatible license.
|
||||||
|
*GPLv3-only modules are not allowed*.
|
||||||
|
|
||||||
|
Special care also needs to be taken with artwork licensing.
|
||||||
|
Cardinal allows the use of CC-NC because how prevalent it is across many Rack modules, but it should be avoided if possible.
|
||||||
|
Also, unless the module is really essential, CC-ND will is not allowed.
|
||||||
|
|
||||||
|
Dependencies should be kept at a minimum, as otherwise it quickly grows the complexity of the build.
|
||||||
|
Online access (such as phone-home) is not allowed.
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
Cardinal was created first and foremost as a way to have Rack as a **proper open-source audio plugin**.
|
Cardinal was created first and foremost as a way to have Rack as a **proper open-source audio plugin**.
|
||||||
|
|
BIN
doc/Screenshot1.png
Normal file
BIN
doc/Screenshot1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.3 MiB |
BIN
doc/Screenshot2.png
Normal file
BIN
doc/Screenshot2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 971 KiB |
Loading…
Add table
Add a link
Reference in a new issue