Extensions
Design guidelines
An extension inside Studio should look like Velum made it. These are the rules that make that true. Listed extensions must follow them; sideloaded ones get the linter's warnings, never a block.
The frame is Studio's
- An extension never draws its own window, title bar, borders, close button or resize handles.
- Docks get Studio's dock frame: a header with the extension's name and icon, pop-out, close, and the standard dock behavior: tabbing, floating, and layout save and restore by its stable
dock_id. - Dock sizes: declare a minimum and a preferred size, in Studio's layout units. The dock must work at its minimum, with nothing cut off and nothing scrolling sideways.
- Property panels for sources, filters and transitions are generated by Studio from the plugin's property schema. A plugin that needs more declares a custom section, drawn with the UI kit inside Studio's Inspector, never a free-standing dialog.
- No modal windows, except the ones Studio provides: confirm, choose a file or folder, and a plain error.
Theme tokens only
- All color, type, spacing, radius and elevation come from the active theme's tokens. Hard-coded colors or fonts break the guidelines.
- Web docks get every token as a CSS custom property (
--velum-color-accent,--velum-space-m, …), injected before your own CSS and updated live when the theme changes. - QML docks get the same tokens as a
VelumThemesingleton. - Native plugins get
host->theme_token(key)and anon_theme_changedcallback, for anything they draw themselves. - Light and dark must both work. When you submit an extension for listing, Studio renders your dock under both built-in themes and a high-contrast one.
- The load-time linter scans web dock CSS for literal colors outside a small allowlist (
transparent,currentColor, and colors inside images), and reports findings in Settings › Developer and in your listing report.
The details for each kind are in Tokens in extensions.
The UI kit
Shipped with Studio, versioned with the plugin SDK, and already themed:
- Web components for web docks: button (primary, secondary, destructive, quiet), icon button, toggle, checkbox, radio, slider with unit, number field with drag-to-scrub (as in Studio), text field, search field, select, segmented control, list and table with selection, tabs, color picker, file and folder picker (Studio's own dialogs), progress, meter, empty state, inline error, toast and tooltips.
- QML equivalents of each.
- Icons: Studio's icon set, plus Lucide by name. Real icons only, never drawn ad hoc. An extension's own icons must be single-color SVGs, tinted by the theme.
Settings › Developer shows a UI kit gallery: every component under the current theme, the reference to copy from.
Words and behavior
- Plain English, the way Studio writes. A setting says what it does, and an error says what to do next.
- Sentence case for labels. No ALL CAPS, except the LIVE and REC badges, which Studio provides.
- Every state is designed. Each dock defines its empty, loading, error and disconnected states, using the kit's components.
- Motion: the kit's durations and easing only, and respect the system's reduce-motion setting.
- Localization: strings live in
locale/. Studio supplies number, time and unit formatting.
Accessibility
- Everything is reachable from the keyboard, with a visible focus ring.
- Every control has a label.
- Text passes WCAG AA under the built-in themes: 4.5:1 against its background. The linter checks text against its background, and these are the pairs Studio holds itself to.
Performance is part of design
- Declare your budget. Docks that are hidden stop drawing.
- Studio shows each extension's cost (CPU, GPU, memory, and its share of frame time) in Settings › Developer, and on a per-plugin line of the stats panel.
- Never cost a frame. If an out-of-process source's frame isn't ready in time, Studio composes with its last good one and counts a late frame against that plugin. Studio never waits for a plugin.
A checklist
Before you submit for listing:
- Studio's frame, no windows or dialogs of your own.
- Tokens only: no literal colors or font names.
- Looks right under Studio Dark, Studio Light and a high-contrast theme.
- Every text and background pair passes 4.5:1.
- Empty, loading, error and disconnected states, all designed.
- Keyboard reachable, visible focus, every control labelled.
- Sentence case, plain English, errors that say what to do next.
- Works at its declared minimum size.
- Stops drawing when hidden, and stays inside its budget.

