diff --git a/Presets.md b/Presets.md new file mode 100644 index 0000000..1f105d5 --- /dev/null +++ b/Presets.md @@ -0,0 +1,40 @@ +# Module Presets + +![](images/presets.png) + +Factory module presets are a great tool for teaching and inspiring users of your Rack plugin. +They store parameter values, as well as internal data from your `Module::dataToJson()` method if overridden. + +To include a factory module preset in your module, save a module preset file (`.vcvm`) to +``` +/presets//.vcvm +``` + +Module presets are sorted alphabetically by filename. +However, (since Rack 2) if a filename begins with numerical digits followed by `_` (regex `/^\d+_/`), that prefix is not displayed to the user, so you can apply your own custom preset sorting order. +For example, the above screenshot uses the following preset filenames. +``` +/presets/DrumMachine/00_House.vcvm +/presets/DrumMachine/01_House 2.vcvm +/presets/DrumMachine/02_Techno.vcvm +/presets/DrumMachine/03_IDM.vcvm +/presets/DrumMachine/04_Moombah.vcvm +/presets/DrumMachine/05_Lounge.vcvm +``` + +Presets can be edited with a text editor to update only a subset of parameters. +For example, to change parameters #0 and #2 but leave #1 unchanged, remove the `"param"` object with `id` 1. +``` + "params": [ + { + "id": 0, + "value": 0.5 + }, + { + "id": 2, + "value": 1.0 + } + ] +``` + +Module presets cannot store module patch storage files (introduced in Rack 2). diff --git a/images/BridgeLive.png b/images/BridgeLive.png deleted file mode 100644 index 540cb57..0000000 Binary files a/images/BridgeLive.png and /dev/null differ diff --git a/images/modulebrowser.png b/images/modulebrowser.png deleted file mode 100644 index 7630a3e..0000000 Binary files a/images/modulebrowser.png and /dev/null differ diff --git a/images/presets.png b/images/presets.png new file mode 100644 index 0000000..434bc42 Binary files /dev/null and b/images/presets.png differ diff --git a/toc.md b/toc.md index 0fa69f2..1b3f685 100644 --- a/toc.md +++ b/toc.md @@ -12,6 +12,7 @@ - [Plugin Development Tutorial](/PluginDevelopmentTutorial) - [Panel Guide](/Panel) - [Plugin Manifest](/Manifest) +- [Module Presets](/Presets) - [Voltage Standards](/VoltageStandards) - [Digital Signal Processing](/DSP) - [Migrating v0.6 Plugins to v1](/Migrate1)