Skip to content

Commit 6bd6cfa

Browse files
committed
Document version switch
1 parent 18b7424 commit 6bd6cfa

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ Example:
4848
| `path` | `string` | Path to the patch location within the repository. Can be a **folder** or a **.zip** file. |
4949
| `formats` | `array` | List of plugin formats to build. Valid values: `VST3`, `AU`, `CLAP`, `LV2`, `Standalone`. |
5050
| `type` | `string` | Type of plugin: either `"fx"` for effects or `"instrument"` for instruments/synths. |
51-
5251
---
5352

5453
### Optional Fields
5554

5655
| Field | Type | Description |
5756
|------------------|-----------|-------------|
57+
| `version` | `string` | Plugin version, new versions will not install correctly unless you increment this. <br>_Default: "1.0.0"
5858
| `enable_gem` | `boolean` | Enables experimental [GEM](https://puredata.info/downloads/Gem) support <br>_Default: `false`_ |
5959
| `enable_sfizz` | `boolean` | Enables the `[sfz~]` object for SFZ sample playback. <br>_Default: `false`_ |
6060
| `enable_ffmpeg` | `boolean` | Enables FFmpeg-based audio objects. <br>Recommended if your patch plays audio files. <br>_Default: `false`_ |

config.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"path": "Plugins/N-TILT.zip",
66
"formats": ["VST3", "AU", "LV2", "CLAP", "Standalone"],
77
"type": "fx",
8+
"version": "1.0.0",
89
"enable_gem": false,
910
"enable_sfizz": false,
1011
"enable_ffmpeg": false
@@ -15,6 +16,7 @@
1516
"path": "Plugins/the gusher.zip",
1617
"formats": ["VST3", "AU", "LV2"],
1718
"type": "fx",
19+
"version": "1.0.0",
1820
"enable_gem": false,
1921
"enable_sfizz": false,
2022
"enable_ffmpeg": false

0 commit comments

Comments
 (0)