Repository navigation
Quick help
Not sure what a button of the pedalboard constructor does? Quick help explains it, without leaving the web interface.
- Click Help on the constructor toolbar. The button stays highlighted and a help panel opens, with a short explanation of the mode.
- Click any element of the interface: the panel shows its description and how to use it.
- Click another element to read about it, as many times as you want.
- Click Help again, or press
Esc, to go back to normal operation.

While Quick help is active, a click only shows the help: it does not press the button or change the control you clicked. You can explore the interface without fear of changing your pedalboard.
| Action | Result |
|---|---|
| Click Help | Turns Quick help on or off |
| Click an element (Quick help on) | Shows its help in the panel |
Esc |
Turns Quick help off |
The help covers the pedalboard constructor and the bars around it, for example:
- the pedalboard title, the save and share actions, the zoom buttons
- snapshots and AB Compare
- the bindings and the CV ports buttons
- the plugin bar
- the status bar at the bottom: CPU and memory, MIDI, Control Chain devices, transport, settings
When an element has no help yet, the panel says so, and shows a help id at the bottom. If you want an element to be documented, report the help id in the forum topic of the release (see Send feedback).
The help pages are Markdown files in html/help/ of mod-ui, one for each help id. An element of the interface
gets its help with a data-help-id attribute: a click shows the help of the element, or of the nearest parent
that has one.