Fix #651, document hasGUI more.

AuburnSounds · May 11, 2022 · abe2f85 · abe2f85
1 parent 315582f
commit abe2f85
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/examples/clipit/plugin.json b/examples/clipit/plugin.json
@@ -8,6 +8,12 @@
     "pluginUniqueID": "ClPi",
     "publicVersion": "1.0.0",
     "CFBundleIdentifierPrefix": "com.wittyaudio",
+
+    "comment-READ-THIS": [
+        "When creating a plug-in, the hasGUI key can be set to false in order to have",
+        "an UI-less plugin"
+    ],
     "hasGUI": true,
+
     "category": "effectDistortion"
 }
diff --git a/examples/distort/plugin.json b/examples/distort/plugin.json
@@ -10,6 +10,12 @@
     "pluginUniqueID": "WiDi",
     "publicVersion": "1.0.0",
     "CFBundleIdentifierPrefix": "com.wittyaudio",
+
+    "comment-READ-THIS": [
+        "When creating a plug-in, the hasGUI key can be set to false in order to have",
+        "an UI-less plugin"
+    ],
     "hasGUI": true,
+
     "category": "effectDistortion"
 }
diff --git a/plugin-schema.json b/plugin-schema.json
@@ -34,7 +34,7 @@
             "type": "string"
         },
         "hasGUI": {
-            "description": "true if the plug-in has a GUI. Can be used to disabled the UI of a plug-in.",
+            "description": "true if the plug-in has a GUI. Can be used to disabled the UI of a plug-in. This is especially practical when creating a new plug-in.",
             "id": "/properties/hasGUI",
             "type": "boolean"
         },