Skip to content

Commit b35d5ca

Browse files
Update README.md
1 parent c69ec4c commit b35d5ca

1 file changed

Lines changed: 58 additions & 4 deletions

File tree

README.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,62 @@
22

33
Note: this is currently still in development, don't use this in production yet!
44

5-
1. Fork this repository
6-
2. Add the plugin definitions you want to build to "config.json", and add the plugins you want to process (either as a folder or .zip file)
7-
3. Wait for github actions to complete, and download your plugins!
5+
1. Fork this repository.
6+
2. Add your patch files and plugin definitions to config.json.
7+
3. Wait for GitHub Actions to complete the build.
8+
4. Download your VST3 / AU / CLAP / LV2 / Standalone plugins!
89

9-
Note: after building, the patch file you use is directly accessible from the "info" menu. This is a requirement for your plugin to comply with the GPL license (required for both plugdata, and the JUCE free tier)
10+
11+
# Config syntax
12+
13+
Example:
14+
```
15+
[
16+
{
17+
"name": "N-SPEC COMP LITE 2",
18+
"author": "Nasko",
19+
"path": "Plugins/N-SPEC COMP LITE 2.zip",
20+
"formats": ["VST3", "AU", "LV2", "CLAP"],
21+
"type": "fx",
22+
"enable_gem": false,
23+
"enable_sfizz": false,
24+
"enable_ffmpeg": false
25+
},
26+
{
27+
"name": "N-TILT",
28+
"author": "Nasko",
29+
"path": "Plugins/N-TILT.zip",
30+
"formats": ["Standalone"],
31+
"type": "fx",
32+
"enable_gem": false,
33+
"enable_sfizz": false,
34+
"enable_ffmpeg": false
35+
}
36+
]
37+
```
38+
39+
## Parameter Reference
40+
41+
### Required Fields
42+
43+
| Field | Type | Description |
44+
|-----------|----------|-------------|
45+
| `name` | `string` | **Unique name** of the plugin. This is how it will appear in your DAW. <br>_Note: You cannot load two plugdata plugins with the same name._ |
46+
| `author` | `string` | Name of the plugin's creator, displayed inside the DAW. |
47+
| `path` | `string` | Path to the patch location within the repository. Can be a **folder** or a **.zip** file. |
48+
| `formats` | `array` | List of plugin formats to build. Valid values: `VST3`, `AU`, `CLAP`, `LV2`, `Standalone`. |
49+
| `type` | `string` | Type of plugin: either `"fx"` for effects or `"instrument"` for instruments/synths. |
50+
51+
---
52+
53+
### Optional Fields
54+
55+
| Field | Type | Description |
56+
|------------------|-----------|-------------|
57+
| `enable_gem` | `boolean` | Enables experimental [GEM](https://puredata.info/downloads/Gem) support <br>_Default: `false`_ |
58+
| `enable_sfizz` | `boolean` | Enables the `[sfz~]` object for SFZ sample playback. <br>_Default: `false`_ |
59+
| `enable_ffmpeg` | `boolean` | Enables FFmpeg-based audio objects. <br>Recommended if your patch plays audio files. <br>_Default: `false`_ |
60+
61+
62+
# Licensing note
63+
After building, the original patch file you used is directly accessible via the “Info” menu in the plugin. This is required to comply with the GPL license (required by both plugdata and the JUCE free tier), as your patch could now legally be considered as "source code" of the generated plugins.

0 commit comments

Comments
 (0)