Mercurial > hg > pub > prymula > com
diff DPF-Prymula-audioplugins/dpf/README.md @ 3:84e66ea83026
DPF-Prymula-audioplugins-0.231015-2
| author | prymula <prymula76@outlook.com> |
|---|---|
| date | Mon, 16 Oct 2023 21:53:34 +0200 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DPF-Prymula-audioplugins/dpf/README.md Mon Oct 16 21:53:34 2023 +0200 @@ -0,0 +1,41 @@ +# DPF - DISTRHO Plugin Framework +[](https://github.com/DISTRHO/DPF/actions/workflows/makefile.yml) +[](https://github.com/DISTRHO/DPF/actions/workflows/cmake.yml) +[](https://github.com/DISTRHO/DPF/actions/workflows/example-plugins.yml) + +DPF is designed to make development of new plugins an easy and enjoyable task. +It allows developers to create plugins with custom UIs using a simple C++ API. +The framework facilitates exporting various different plugin formats from the same code-base. + +DPF can build for LADSPA, DSSI, LV2, VST2, VST3 and CLAP formats. +A JACK/Standalone mode is also available, allowing you to quickly test plugins. + +Plugin DSP and UI communication is done via key-value string pairs. +You send messages from the UI to the DSP side, which is automatically saved in the host when required. +(You can also store state internally if needed, but this breaks DSSI compatibility). + +Getting time information from the host is possible. +It uses the same format as the JACK Transport API, making porting some code easier. + +Provided features and implementation status for specific plugin formats can be seen in [FEATURES.md](FEATURES.md). + +## Licensing + +DPF is released under ISC, which basically means you can do whatever you want as long as you credit the original authors. +Some plugin formats may have additional restrictions, see [LICENSING.md](LICENSING.md) for details. + + +## Help and documentation + +Bug reports happen on the [DPF github project](https://github.com/DISTRHO/DPF/issues). + +Online documentation is available at [https://distrho.github.io/DPF/](https://distrho.github.io/DPF/). + +Online help and discussion about DPF happens in the [kx.studio chat, DPF room](https://chat.kx.studio/channel/dpf). + + +## List of plugins made with DPF: + +See [this wiki page](https://github.com/DISTRHO/DPF/wiki/Plugins-made-with-DPF) for a list of plugins made with DPF. + +Plugin examples are also available in the `example/` folder inside this repo.