Browse Source

Add Module Presets page.

master
Andrew Belt 3 years ago
parent
commit
8e40fc70c4
5 changed files with 41 additions and 0 deletions
  1. +40
    -0
      Presets.md
  2. BIN
      images/BridgeLive.png
  3. BIN
      images/modulebrowser.png
  4. BIN
      images/presets.png
  5. +1
    -0
      toc.md

+ 40
- 0
Presets.md View File

@@ -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
```
<your plugin's root dir>/presets/<module slug>/<preset name>.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).

BIN
images/BridgeLive.png View File

Before After
Width: 1274  |  Height: 1194  |  Size: 125KB

BIN
images/modulebrowser.png View File

Before After
Width: 634  |  Height: 474  |  Size: 24KB

BIN
images/presets.png View File

Before After
Width: 142  |  Height: 342  |  Size: 11KB

+ 1
- 0
toc.md View File

@@ -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)


Loading…
Cancel
Save