Contents
-
Create a new module that is 50.8mm (10 units) wide
new module "bodacious" 1U 10H -
Create vertical guidelines to position inputs, outputs and parameters:
new guide vertical @10.16mmnew guide v1+12.7mmnew guide right-10.16mm -
Add a horizontal guideline to position inputs, outputs and parameters:
new guide horizontal @20.32mmnew guide h1+3Hnew guide top+10.16mmnew guide bottom-15.24mm -
Set the background:
set background "fundamental" -
Create some inputs:
new input "frequency" v1,h1 PJ301Mnew input "volume" v1,h2 PJ301M -
Create some outputs:
new output "left" v3,h4-10.16mm PJ301Mnew output "right" v3,h4 PJ301M -
Create some parameters:
new parameter "volume" v2,h1 RoundBlackKnobnew parameter "distortion" v2,h2 RoundBlackKnob -
Create some lights:
new light "ok" centre,middle LEDnew light "recording" centre,middle+12.7mm LED -
Create a custom widget:
new widget "channels" @40.64mm,20.32mm square -
Add a title:
new label "Thing 1" centre,h3 "StyleScript-Regular" 16pt centre,baseline #c000ff,#00e000 -
Label the inputs:
new label "FREQ" (input "frequency"+0mm,-5.08mm) "RobotoCondensed-Regular" 8pt centre,baselinenew label "VOL" (input "volume" +0mm,-5.08mm) "RobotoCondensed-Regular" 8pt centre,baseline -
Label the outputs:
new label "LEFT" (output "left" -5.08mm,+0mm) "RobotoCondensed-Bold" 8pt right,middlenew label "RIGHT" (output "right" -5.08mm,+0mm) "RobotoCondensed-Bold" 8pt right,middle -
Decorate the parameter knobs with graduations:
decorate (parameter "volume") with "CircularGraduations" (scale 1.25)decorate (parameter "distortion") with "CircularGraduations" (scale 1.25) -
Decorate the outputs with rectangular pads:
decorate (output "left" -3.54mm,+0.0mm) with Pad (stretch 2,0.9)decorate (output "right" -3.54mm,+0.0mm) with Pad (stretch 2,0.9) -
Save the project files:
save projectsave script
The current state of a project is saved in the browser local storage and the application will do its level best to resume where you last left off, but really you should save a project if it contains any significant work or changes.
A .vpd project file is a just a human readable JSON file that can be loaded (or dropped on to the panel design area) to recreate a module.
-
To load a .vpd file:
-
On the user interface click the File Load button (
) to open
a file chooser dialog.-- or --
-
Drag 'n drop a .vpd file on to the panels design area of the user interface.
-- or --
-
Execute the
load projectcommand to open a file picker.
-
-
To save a project to a .vpd file:
-
On the user interface click the File Save button (
) to open
a file chooser dialog (on Chrome - on other browsers the file will be automatically downloaded).-- or --
-
Execute the
save projectcommand which will either open a file chooser dialog (Chrome) or just download and save the file.
-
A .vpx script file is simply a text file of VPD commands (one per line) that can be loaded (or dropped on to the panel design area) to recreate a module, e.g.
new module "bodacious" 1U 10H
new guide vertical @10.16mm
new guide v1+10.16mm
new guide v2+10.16mm
...
...
To load a .vpx file:
-
On the user interface Alt-click (Option-click on MacOS) the File Load button (
) to open
a file chooser dialog.-- or --
-
Drag 'n drop a .vpx file on to the user interface panels.
-- or --
-
Execute the
load scriptcommand to open a file chooser dialog.
To save a project as a .vpx file:
-
On the user interface Alt-click (Option-click on MacOS) the File Save button (
) to open
a file chooser dialog.-- or --
-
Execute the
save scriptcommand to open a file chooser dialog.
- Clicking on the Load button loads and renders a module saved as a .vpd file.
- Alt-click on the Load button loads and renders a .vpx script file.
-
Clicking on the Save button saves the current project as a .vpd file, using the module name as a filename.
ctrl-clickwill save the project with a timestamped filename. -
alt-clickon the Save button saves the command history as a .vpx script file, using the module name as a filename.ctrl-alt-clickwill save the script with a timestamped filename.
- Clicking on the Export SVG button saves the current panel as an SVG file that can be used as a plugin resource.
- Clicking on the Export dark SVG button saves the 'dark theme' panel as an SVG file that can be used as a plugin resource. The SVG file is saved with a -dark suffix.
- Clicking on the .h button saves the panel layout XY coordinates as a C++ header file.
- Clicking on the > button copies the helper.py script to generate a new module to the clipboard.
- Undoes the last command and displays it in the command entry panel. Please see note below in redo.
- Redo undoes the ost recent Undo and displays the next command (if any).
The redo implementation is fairly basic and executing any command other than another undo or redo clears the redo stack i.e. save the script if you have recent changes you would rather not lose.
The undo/redo implementation is mostly intended as a convenience to review recent commands and for fixing simple mistakes. More complex changes should rather be done by editing and reloading a VPX script.
The macro keys (Ctrl-1 to Ctrl-0) can be programmed with commonly used commands (e.g save project timestamp gzip). Clicking on a
macro key (or pressing e.g. ctrl-1) will paste the command into the command area where it can be edited and then executed with Enter.
To assign a command to a macro key:
- Type the command into the command area
- Alt-click (Option-click on a Mac) on the macro key button to assign the command to that key.
- A macro key command can be viewed by hovering over the key (or of course, just click on it to paste the command into the command area)
The macro keys assignments are stored only in the browser local storage and are not included in the project file.
The command area comprises two components:
- the command line, for entering a VPD command. Commands are executed by pressing Enter.
- the hint area, which displays the possible command variations starting from the current command line.
A command starting with a double semi-colon is a comment, e,.g,
;; new module bodacious 1U 5H
This is mostly for use in scripts but it's occasionally useful when assigning a command to a macro key.
VPD supports the following units of measurement:
mm(millimeters)H(standard horizontal units of 5.08mm)h(half-standard horizontal units of 2.54mm)- 'U' (standard rack unit height, 128.5mm)
The U unit is the height of a panel and is only be used with the new module command - and TBH it's there for aesthetics only
because a panel height may be 1U only, no more no less.
Examples:
10.16mm
2.5H
3.5h
1U
| Type | <xy> |
Description | Example |
|---|---|---|---|
| absolute | @x,y |
Absolute x,y location in mm relative to the top left corner of the panel | @4.5mm,7.62mm |
@angle,radius |
Absolute x,y location in polar coordinates relative to the top left corner of the panel. The angle may be written as °,deg or degrees |
@30°,10.16mm or 30deg,10mm or 30degrees,10mm |
|
| relative | x,y |
x,y location in mm relative to the origin | 4.5mm,-7.62mm |
angle,radius |
x,y location in mm relative to the origin | 30°,10.16mm |
|
| geometry | h,v |
x,y location relative to the geometry of the panel | left+4mm,top+10.16mm |
(h,v angle,radius) |
x,y location in polar coordinates, relative to the geometry of the panel | (top,left 30°,10.16mm) |
|
| guides | h,v |
x,y location relative to the guidelines | v1+4mm,h1-10mm |
(h,v angle,radius) |
x,y location in polar coordinates relative to the guidelines | (v1,h1 30°,10.16mm) |
|
| reference | (e [x,y]) |
x,y location relative to the component e | (input "audio" +4.5mm,-4.5mm) |
(e [angle,radius]) |
x,y location in polar coordinates relative to the component e | (input "audio" 30°,10.16mm) |
Components can be displayed on the overlay layer as the physical representation of the component. The current list of parts comprises:
RoundBlackKnobPJ301MTrimpotPushButtonButtonSliderLED
An unknown part will be displayed as an anonymous grey circle devoid of personality, joy or future.
VPD is a static web app and CORS restrictions mean it cannot load external fonts from e.g. Google Fonts. The following fonts are included in the app:
- Lato-Regular
- Lato-Semibold
- Lato-Bold
- RobotoMono-Regular
- RobotoMono-Bold
- RobotoCondensed-Regular
- RobotoCondensed-Bold
- StyleScript-Regular
TTF, OTF and WOFF fonts can be loaded using the load font command - WOFF2 fonts aren't supported because the available JS and
Rust woff2 decoders didn't seem to work all that well. To use a woff2 font convert it to TTF using one of the many, many tools out there.
set origin <xy>
The origin is the default relative reference point for locating elements and guidelines. By default the origin is located at the
top left corner of the panel - the set origin command moves the origin to the <xy> location and all elements referencing the
origin will be relocated relative to the new position.
Command options:
xy New origin location. May be an absolute location or a reference to the geometry of the panel.
Examples:
set origin @10mm,10mm
set origin @30°,10mm
set origin centre,middle
set origin left+2.54mm,top+10.16mm
set origin top,left -30°,10.16mm
new guide [label] [orientation] <location>
Creates a construction guideline that can be used to locate or align inputs, outputs, etc. The components that reference the guideline will be relocated if the guideline is moved.
Command options:
label (optional) guideline label. Must be unique - default labels will be automatically generated if an explicit label is not
provided, as _vNN_ for vertical guidelines (e.g. _v1_) and _hNN_ for horizontal guidelines (e.g. _h2_).
orientation 'vertical' or 'horizontal'. Required if the guideline is located using either an absolute location or a location
relative to the origin, otherwise it is automatically derived from the referenced guideline or geometry.
location Location of the guideline, either as an absolute offset from the top/left of the panel, an offset from the origin
or an offset from the geometry of the panel.
Notes:
- The location can be:
- absolute e.g.
new guide vertical @4.5mm - relative to the origin e.g.
new guide vertical +4.5mm - relative to the geometry e.g.
new guide centre - relative to another guide e.g.
new guide v1+4.5mm
- absolute e.g.
- Geometry values are:
left | centre | rightfor vertical guidelinestop | middle | bottomfor horizontal guidelines
verticalandhorizontalare optional for guidelines that reference the panel geometry.V0andH0can be used to reference the vertical and horizontal guides at the origin, i.e.new guide V0+4.5mmis the same asnew guide vertical +4.5mm
Examples
new guide v1 vertical @4.5mm
new guide vertical +4.5mm
new guide vertical -4.5mm
new guide vertical left
new guide center
new guide v1+10.16mm
new guide vertical v1+2H
new guide horizontal middle
new guide middle
new guide H0+7.62mm
delete guide <id>
Removes a construction guideline.
Command options:
id Label identifiying guideline to delete
Notes:
- Quite happily deletes guidelines that do not exist.
- Deleting a guideline referenced by other guidelines or components will set those entities adrift to
wander in space and time. Creating a new guideline with the missing identifier (
new guideline <label> ...) will anchor them to the new reality.
Examples
delete guide v1
set guide <id> id <new-id>
set guide <location>
Changes the location or ID of a guide.
Command options:
id Identifier of the guide to update
new-id New guide ID
location New guide location.
Notes:
- Other components, labels and decorations that reference the guide by id are migrated automatically when the guide
idis changed.
Examples:
set guide v1 id v2
set guide v1 @10.6mm
set guide v1 10.6mm
set guide v1 left+10.6mm
set guide v2 v1+10.6mm
new module <name> [height] <width>
Creates and initialises a new module.
Command options:
name Module name, optionally surrounded by single or double quotes
height (optional) panel height. The only valid values are 1U or 128.5mm
width Panel width, in mm or _horizontal units_ (H) of 5.08mm. The width in mm
is rounded to the nearest integer multiple of 5.08mm (e.g. a value of 45mm
is rounded 45.72mm)
Notes:
Examples:
new module bodacious 1U 5H
new module bodacious 1U 45mm
new module bodacious 45.72mm
set module name <name>
Sets the module name.
Command options:
name Module name, optionally surrounded by single or double quotes.
Notes:
Examples:
set module name Thing1
set module name 'Thing 1'
set module name "Thing 1"
set module height <height>
Sets the module panel height.
Command options:
height Module panel height (128.5mm or 1U).
Notes:
Examples:
set module height 1U
set module height 128.5mm
set module width <width>
Sets the module panel width.
Command options:
width Module panel width in either mm or H (standard horizontal units of 5.08mm). A module width
in mm is rounded to the nearest multiple of 5.08mm.
Notes:
Examples:
set module width 50mm
set module width 10H
set background none|<rgb>[,<rgb>]|<rgba>[,<rgba>]|name
Sets the panel background to either a plain colour or the name of a preloaded backround.
Command options:
none Removes the background from the SVG
rgb RGB colour hex value e.g. #ff0000
rgba RGBA colour hex value e.g. #ff000040
name Name of a predefined background, optionally surrounded by single or double quotes
Notes:
- The default background is a transparent rectangle
rgbandrgbabackgrounds can optionally specify a dark mode background colour.- The background name is case- and space-insensitive
- The predefined backgrounds are:
fundamental
Examples:
set background none
set background #ff00ff
set background #ff00ff,#00ff00
set background #ff00ff40
set background #ff00ff40,#00ff0080
set background fundamental
new input <name> <xy> [part]
Creates an input component placeholder in the components layer of the SVG and (optionally) displays the physical
input on the overlay layer. The overlay is for display only and is not exported to the resource SVGs when exported.
Command options:
name Input name, optionally surrounded by single or double quotes and used by the VCV plugin helper scripts
to generate the module skeleton. Should be unique unless you're deliberately trying to make the C++
compiler miserable.
xy Location of the centre of the input component. Must be one of the supported location formats (described
[above](#location-formats)).
part (optional) Physical part to display on the overlay - a red circle is displayed on the overlay if a part
is not provided.
Notes:
Examples:
new input frequency @10.16mm,10.16mm
new input frequency @30°,10.16mm
new input frequency @10.16mm,10.16mm PJ301M
new input frequency 10.16mm,10.16mm PJ301M
new input frequency 30°,10.16mm PJ301M
new input frequency left+5.08mm,top+2H PJ301M
new input frequency (left,top 30°,10.16mm)
new input frequency v1+5.08mm,h2+7.62mm PJ301M
new input frequency (v1,h2 30°,10.16mm) PJ301M
new input frequency (parameter p1 10.16mm,5.08mm) PJ301M
new input frequency (parameter p1 30°,10.16mm) PJ301M
delete input <id>|<name>
Removes an input component identified either by the automatically assigned identifier or the name
supplied to the new input command.
Command options:
id Identifier of the input to delete (the identifier is the automatically generated ID assigned to the input)
name Name of input.
Notes:
- Blissfully ignores the command if the input does not exist.
- Deleting an input referenced by other components will set those entities loose to drift around aimlessly, so hopefully it was what you really wanted to do and also have a backup handy.
Examples
delete input i1
delete input audio
set input <id|name> <attribute> <value>
Changes the value of an input attribute.
Command options:
id Identifier of the input to update (the identifier is the automatically generated ID assigned to the input)
name Name of input.
attribute Input attribute - one of name,x,y,xy or part
value New attribute value.
Notes:
- Other components, labels and decorations that reference the input by name are migrated automatically when the
nameof the input is changed.
Examples:
set input i1 name 'FREQ'
set input freq name 'FREQ'
set input freq x v1+10mm
set input freq y @55.5mm
set input freq x v1+10mm
set input freq xy v1,h1
set input freq xy (v1,h1 30°,10mm)
set input freq xy (parameter in +10mm,+10mm)
set input freq xy (parameter in 30°,10mm)
set input freq x (parameter in -2H)
set input freq y (parameter in +5h)
set input freq part PJ301M
set input freq part none
new output <name> <xy> [part]
Creates an output component placeholder in the components layer of the SVG and (optionally) displays the physical
input on the overlay layer. The overlay is for display only and is not exported to the resource SVGs when exported.
Command options:
name Output name, optionally surrounded by single or double quotes and used by the VCV plugin helper scripts
to generate the module skeleton. Should be unique unless you have a really good reason for it not to be.
xy Location of the centre of the output component. Must be one of the supported location formats (described
[above](#location-formats)).
part (optional) Physical part to display on the overlay - a red circle is displayed on the overlay if a part
is not provided.
Notes:
Examples:
new output audio @10.16mm,10.16mm
new output audio @10.16mm,10.16mm PJ301M
new output audio 10.16mm,10.16mm PJ301M
new output audio left+5.08mm,top+2H PJ301M
new output audio (left,top 30°,10mm) PJ301M
new output audio v1+5.08mm,h2+7.62mm PJ301M
new output audio (v1,h2 30°,10mm) PJ301M
delete output <id>|<name>
Removes an output component identified either by the automatically assigned identifier or the name
supplied to the new output command.
Command options:
id Identifier of the output to delete (the identifier is the automatically generated ID assigned
to the output)
name Name of output.
Notes:
- Unknown output IDs or names are totally acceptable.
- Deleting an output referenced by other components will cause irreversible mayhem and chaos, but that's life Jim.
Examples
delete output o1
delete output left
set output <id|name> <attribute> <value>
Changes the value of an output attribute.
Command options:
id Identifier of the output to update (the identifier is the automatically generated ID assigned to the output)
name Name of output.
attribute Output attribute - one of name,x,y,xy or part
value New attribute value.
Notes:
- Other components, labels and decorations that reference the output by name are migrated automatically when the
nameof the output is changed.
Examples:
set output o1 name 'LEFT'
set output left name 'RIGHT'
set output left x v1+10mm
set output left y @55.5mm
set output left x v1+10mm
set output left xy v1,h1
set output left xy (v1,h1 30°,10mm)
set output left xy (output right +10mm,+10mm)
set output left xy (output right 30°,10mm)
set output left x (output right -2H)
set output left y (output right +5h)
set output left part PJ301M
set output left part none
new parameter <name> <xy> [part]
Creates a parameter component placeholder in the components layer of the SVG and (optionally) displays the physical
input on the overlay layer. The overlay is for display only and is not exported to the resource SVGs when exported.
Command options:
name Parameter name, optionally surrounded by single or double quotes and used by the VCV plugin helper scripts
to generate the module skeleton. Should be unique but the compiler will barf if you mess it up.
xy Location of the centre of the parameter component. Must be one of the supported location formats (described
[above](#location-formats)).
part (optional) Physical part to display on the overlay - a red circle is displayed on the overlay if a part
is not provided.
Notes:
Examples:
new parameter volume @10.16mm,10.16mm
new parameter volume @30°,10.16mm
new parameter volume @10.16mm,10.16mm PJ301M
new parameter volume 10.16mm,10.16mm PJ301M
new parameter volume left+5.08mm,top+2H PJ301M
new parameter volume (left,top 30°,10.16mm) PJ301M
new parameter volume v1+5.08mm,h2+7.62mm PJ301M
new parameter volume (v1,h2 30°,10.16mm) PJ301M
delete parameter <id>|<name>
Removes a parameter component identified either by the automatically assigned identifier or the name
supplied to the new parameter command.
Command options:
id Identifier of the parameter to delete (the identifier is the automatically generated ID assigned to
the parameter)
name Name of parameter.
Notes:
- Unknown parameters IDs or names are silently ignored.
- Deleting a parameter referenced by a decoration or another component will be ummm, interesting.
Examples
delete parameter p1
delete parameter 'volume'
set parameter <id|name> <attribute> <value>
Changes the value of a parameter attribute.
Command options:
id Identifier of the parameter to update (the identifier is the automatically generated ID assigned to the parameter)
name Name of parameter.
attribute parameter attribute - one of name,x,y,xy or part
value New attribute value.
Notes:
- Other components, labels and decorations that reference the parameter by name are migrated automatically when the
nameof the parameter is changed.
Examples:
set parameter p1 name 'gain'
set parameter volume name 'gain'
set parameter volume x v1+10mm
set parameter volume y @55.5mm
set parameter volume x v1+10mm
set parameter volume xy v1,h1
set parameter volume xy (v1,h1 30°,10,16mm)
set parameter volume xy (input i1 30°,10,16mm)
set parameter volume part RoundGreenKnob
set parameter volume part none
new light <name> <xy> [part]
Creates a light component placeholder in the components layer of the SVG and (optionally) displays the physical
input on the overlay layer. The overlay is for display only and is not exported to the resource SVGs when exported.
Command options:
name Light name, optionally surrounded by single or double quotes and used by the VCV plugin helper scripts
to generate the module skeleton. Should be unique but really it's up to you.
xy Location of the centre of the light component. Must be one of the supported location formats (described
[above](#location-formats)).
part (optional) Physical part to display on the overlay - a purple circle is displayed on the overlay if a part
is not provided.
Notes:
Examples:
new light "on" @10.16mm,10.16mm
new light "on" @30°,10.16mm
new light on @10.16mm,10.16mm LED
new light on 10.16mm,10.16mm LED
new light on 30°,10.16mm LED
new light recording left+5.08mm,top+2H "Red LED"
new light recording (left,top 30°,10.16mm) "Red LED"
new light recording v1+5.08mm,h2+7.62mm "Red LED"
new light recording (v1,h2 30°,10.16mm) "Red LED"
new light recording (parameter recording) LED
new light recording (parameter recording 30°,10.16mm) LED
delete light <id>|<name>
Removes a light component identified either by the automatically assigned identifier or the name
supplied to the new light command.
Command options:
id Identifier of the light to delete (the identifier is the automatically generated ID assigned to
the light)
name Name of light.
Notes:
- Silently ignored if the light does not exist or is otherwise unavailable for comment
- Deleting a light referenced by a decoration or another component is ok but probably not what you wanted to do.
Examples
delete light p1
delete light 'LED'
set light <id|name> <attribute> <value>
Changes the value of a light attribute.
Command options:
id Identifier of the light to update (the identifier is the automatically generated ID assigned to the light)
name Name of light.
attribute light attribute - one of name,x,y,xy or part
value New attribute value.
Notes:
- Other components, labels and decorations that reference the light by name are migrated automatically when the
nameof the light is changed.
Examples:
set light l1 name 'off'
set light on name 'off'
set light on x v1+10mm
set light on y @55.5mm
set light on x v1+10mm
set light on xy v1,h1
set light on xy (v1,h1 30°,10mm)
set light on part RedLED
set light on part none
new widget <name> <xy> [part]
Creates a widget component placeholder in the components layer of the SVG and (optionally) displays the physical
input on the overlay layer. The overlay is for display only and is not exported to the resource SVGs when exported.
Command options:
name Widget name, optionally surrounded by single or double quotes and used by the VCV plugin helper scripts
to generate the module skeleton. Should be unique otherwise you won't be able to tell them apart.
xy Location of the centre of the widget component. Must be one of the supported location formats (described
[above](#location-formats)).
part (optional) Physical part to display on the overlay - a yellow circle is displayed on the overlay if a part
is not provided.
Notes:
Examples:
new widget "channels" @10.16mm,10.16mm
new widget "channels" @30°,10.16mm
new widget channels @10.16mm,10.16mm "ChDsp"
new widget channels 10.16mm,10.16mm "ChDsp"
new widget channels 30°,10.16mm "ChDsp"
new widget channels left+5.08mm,top+2H "ChDsp"
new widget channels (left,top 30°,10mm) "ChDsp"
new widget channels v1+5.08mm,h2+7.62mm "ChDsp"
new widget channels (v1,h2 30°,10mm) "ChDsp"
delete widget <id>|<name>
Removes a widget component identified either by the automatically assigned identifier or the name
supplied to the new widget command.
Command options:
id Identifier of the widget to delete (the identifier is the automatically generated ID assigned to
the widget)
name Name of widget.
Notes:
- Widgets that don't exist get deleted anyway.
- Deleting a Widgets referenced by a decoration or another component is going to shuffle the panel layout in very unexpected ways. But it's your panel, you may do what you wish with it...
Examples
delete widget w1
delete widget 'ChDsp'
set widget <id|name> <attribute> <value>
Changes the value of a widget attribute.
Command options:
id Identifier of the widget to update (the identifier is the automatically generated ID assigned to the widget)
name Name of widget.
attribute widget attribute - one of name,x,y,xy or part
value New attribute value.
Notes:
- Other components, labels and decorations that reference the widget by name are migrated automatically when the
nameof the widget is changed.
Examples:
set widget w1 name 'display'
set widget display name 'dsp'
set widget display x v1+10mm
set widget display y @55.5mm
set widget display x v1+10mm
set widget display xy v1,h1
set widget display xy (v1,h1 30°,10.16mm)
set widget display part LCD
set widget display part none
new label <text> <xy> [font] [font-size] [halign,valign] [colour]
Creates a text label and converts it to an SVG path.
Command options:
text Label text, optionally surrounded by single or double quotes
xy Location, either as absolute co-ordinates, relative to the origin or relative to the
geometry of the panel.
font (optional) name of preloaded font. Defaults to RobotoMono-Bold.
font-size (optional) font size (points). Defaults to 12pt.
halign (optional) horizontal alignment (left, centre or right). Defaults to left.
valign (optional) vertical alignment (top, middle, baseline or bottom). Defaults to baseline.
colour (optional) text colour pair. The colour may be either standard colour names (e.g. red, blue),
RGB (e.g. #ff000) or RGBA (e.g. #ff000080). The default colours are #222222 for the
light themed panel and #ebebeb for the dark themed panel.
Notes:
- The preloaded fonts are:
Lato-RegularLato-BoldRobotoMono-RegularRobotoMono-BoldRobotoCondensed-RegularRobotoCondensed-BoldStyleScript-Regular
- Font names are case- and space-insensitive
Examples:
new label "Lorem Ipsum" centre, top+10.16mm
new label "Lorem Ipsum" (centre, top 30°,10.16mm)
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" 14.5pt centre
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" 14.5pt centre,baseline
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" 14.5pt centre,baseline red
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" 14.5pt centre,baseline #ffff0080
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" 14.5pt centre,baseline #ff0000,#00ff00
new label "Lorem Ipsum" centre, top+10.16mm "Lato-Bold" baseline #ff0000,#00ff00
delete label <id>|<string>
Removes a text label identified either by the automatically assigned identifier or the label text
supplied to the new label command.
Command options:
id Identifier of the label to delete (the identifier is the automatically generated ID assigned to
the label)
text Exact label text (in single or double quotes). Case and space sensitive.
Notes:
- Doesn't matter in the least if you delete a label that doesn't exist.
Examples
delete label t1
delete label 'lorem ipsum'
set label <id|text> <attribute> <value>
Changes the value of a label attribute.
Command options:
id Identifier of the label to update (the identifier is the automatically generated ID assigned to the label)
text Label text.
attribute label attribute - one of text,x,y,xy,font,size,halign,valign,align or colour
value New attribute value.
Notes:
- Other components, labels and decorations that reference the label by name are migrated automatically when the
textof the widget is changed.
Examples:
set label l1 text 'uiop'
set label qwerty text 'uiop'
set label qwerty x v1+10mm
set label qwerty y @55.5mm
set label qwerty xy v1,h1
set label qwerty xy (v1,h1 30°,10mm)
set label qwerty font RobotoMono-Bold
set label qwerty size 14.5pt
set label qwerty halign centre
set label qwerty valign middle-10.6mm
set label qwerty align centre,baseline
set label qwerty colour #ff000
set label qwerty colour #ff000,#00ff00
decorate (<component> <name> <offset>)with <decoration> [scale] [stretch]
Adds a decoration (e.g. graduations, output pad) to an input, output, parameter, light or widget.
Command options:
component input, output, parameter, light or widget. Used to disambiguate component references.
name name or ID of the component to decorate.
offset (optional) xy offset by which to adjust decoration. Defaults to (0.0,0.0).
decoration name of a predefined decoration.
scale (optional) amount by which to scale the decoration so that it matches the size of the
of the component when rendered on the panel.
stretch (optional) stretches the decoration vertically and/or horizontally without changing the
appearance (e.g. rounded corners keep the same radius). Defaults to (1,1)
Notes:
- The predefined decorations are:
CircularGraduations, a graduations decoration for parameter knobs.Pad, a rectangular pad to highlight outputs.
- Decoration names are case- and space-insensitive.
- Not all decorations support scale and/or stretch.
Examples:
decorate (parameter "volume") with "CircularGraduations"
decorate (parameter "volume") with "CircularGraduations" (scale 1.1)
decorate (output "audio" +0.0mm,-2.54mm) with Pad (stretch 1,1.5)
decorate (output "audio" 30°,10mm) with Pad (stretch 1,1.5)
delete decoration <id>
delete decoration (<component>) <name>
Removes a decoration from a component. The decoration may be identified either by the automatically assigned
identifier or the component reference supplied to the decorate command.
Command options:
id Identifier of the widget to delete (the identifier is the automatically generated ID assigned to
the widget)
component Component type and identifier (e.g. input 'audio')
name Name of decoration.
Notes:
Examples
delete decoration d1
delete decoration (input 'audio') CircularGraduations
set decoration <id> <attribute> <value>
set decoration <reference> <name> <attribute> <value>
Changes the offset, stretch or scale values of a decoration.
Command options:
id Identifier of the decoration to update (the identifier is the automatically generated ID assigned to the decoration)
reference Reference to component to which decoration is attached, e.g. (input frequency)
name Decoration 'name' e.g. Pad
attribute decoration attribute - one of dx,dy,dxy,stretch or scale
value New attribute value.
Notes:
- dx, dy and dxy attributes set the offset relative to the reference component.
Examples:
set decoration d1 dx +10mm
set decoration d1 dy -12.5mm
set decoration d1 dxy +10mm,-12.5mm
set decoration d1 (stretch 1.1,0.9)
set decoration d1 (scale 0.5)
set decoration (input frequency) CircularGraduations x +10mm
set decoration (output left) Pad (stretch 1.25,2.5)
set decoration (output left 30°,10.16mm) Pad (stretch 1.25,2.5)
load project
Opens a file chooser to load a .vpd project file.
Example:
load project
save project [timestamp] [gzip]
Saves the current project to a .vpd project file, using the module name as the suggested filename. On Chrome it
opens a file chooser to save the file - on Firefox and most other browsers the file is downloaded automatically.
Command options:
timestamp (optional) the suggested file name is suffixed with the current date and time
gzip (optional) compresses the project with gzip
Notes:
- Compressed projects have a .vpz extension.
Example:
save project
save project timestamp
save project gzip
save project timestamp,gzip
load script
Opens a file chooser to load a .vpx script file.
Example:
load script
save script [timestamp]
Saves the commands required to recreate the current project to a .vpx script file, using the module name as the suggested filename. On
Chrome it opens a file chooser to save the file - on Firefox and most other browsers the file is downloaded automatically.
Command options:
timestamp (optional) the suggested file name is suffixed with the current date and time
Notes:
Example:
save script
save script timestamp
export panel svg [light|dark]
Exports the panel as an SVG for use as a plugin resource file, using the module name as the suggested
filename (with a -dark suffix for the dark theme SVG).
Command options:
svg (required) exports SVG file
light (optional) exports the default panel SVG
dark (optional) exports the dark themed SVG
Notes:
- Non-alphanumeric characters in the module name are replaced with underscores.
Examples:
export panel svg
export panel svg light
export panel svg dark
export module .h
Exports the panel layout as a C++ .h file with the component locations.
Command options:
.h (required) exports header file
Notes:
- Non-alphanumeric characters in the module name are replaced with underscores.
Examples:
export module .h
export module >>
Copies the helper.py command line script to generate a new VCV module to the clipboard.
Command options:
>> (required) exports helper script
Notes:
- Non-alphanumeric characters in the module name are replaced with underscores.
Examples:
export module >>
load font
Opens a file picker for a TTF, OTF or woff font. The font is stored in the browser local storage until deleted with an unload font
Command options:
Notes:
- The font name is the file name without the extensions.
- Browser local storage is typically limited to around 5MB - or about 10 fonts (depending on the file size)
Examples:
load font
unload font <font>
Removes the font from the browser local storage.
Command options:
font (required) name of font to be removed (case- and space-insensitive)
Notes:
- It's quite ok to remove a font that isn't loaded. We all do it at some point in time..
- Labels are converted to paths when created so unloading a font does not change a label. Updating a label
with
set label...on the other will cause all hell to break loose because the label will be repathed (?) with the default font. Probably not what you want.
Examples:
unload font ComicSans-BoldItalic
list fonts
Displays a list of the preloaded and user loaded fonts.
Command options:
Notes:
Examples:
list fonts
list parts
Displays a list of the preloaded and user loaded parts.
Command options:
Notes:
Examples:
list parts
list decorations
Displays a list of the preloaded and user loaded decorations.
Command options:
Notes:
Examples:
list decorations