Developer
Log in

Extensions

Packaging and signing

An extension ships as one .velumplugin file: a signed zip holding its manifest, its binaries for each platform, its UI and its licences.

What Studio does with one today

Open a .velumplugin in Studio and it checks it fully (the container, the manifest, the hashes and the signature), shows its trust level, and installs it. It refuses, and says why, a package Studio can't run: a different ABI major, a newer minor than it has, no binary for this computer, or kinds that don't include source (the only kind that runs so far).

The package

A .velumplugin uses the same Velum file container as every other Velum file, with plugin.json as its own content:

Text
my-plugin.velumplugin  (a zip)
  manifest.json        the container's manifest: every file's path, SHA-256 and size
  plugin.json          what the plugin is
  bin/<platform>/      the native binaries, one folder per platform
  ui/                  a web dock's files, or a QML dock's root
  locale/              translated strings
  LICENSES/            licences for everything bundled
  signature.ed25519    the signature over manifest.json

plugin.json

Field Meaning
id Reverse-DNS, such as com.example.chatwall. Stable forever.
name Shown to people.
version major.minor.patch.
abi {"major", "minMinor"}: the plugin ABI it was built against. A different major won't load; minors only add, so a newer Studio loads older plugins.
kinds Any of source, filter, transition, output, encoder, dock, automation, detector. Studio runs source today; the rest are planned.
sourceTypes For a source plugin, each source type it offers: {"id", "name", "video", "audio"}, matching its VelumSourceTypes. Add source lists them before any of the plugin's code runs.
binaries Per platform: windows-x64, windows-arm64, macos-universal, linux-x64, linux-arm64.
permissions What it needs, shown at install. See Permissions.
dockIds The stable ids of its docks, registered before Studio restores the layout, so a dock comes back where it was.

Limits

Files in the package 20,000
Unpacked in total 2 GB
Any one file 512 MB

Every path must stay inside the package: no absolute paths, no .., no backslashes, no names that differ only in case, no links. A file in the archive but not in the manifest, or the other way round, makes the whole package invalid. The full reading rules are in Velum files.

Signing

signature.ed25519 is JSON:

JSON
{"key": "<Ed25519 public key, 64 hex digits>", "signature": "<128 hex digits>"}

The signature is Ed25519 over the exact bytes of manifest.json. The manifest holds the SHA-256 of every other file, so one signature covers the whole package. Binaries are also signed the way each OS expects: Authenticode on Windows, Developer ID and notarization on macOS.

Level Signature
First-party Signed by the publisher, Legendre Media Inc.
Verified Signed with a developer key registered with the publisher, and countersigned by the publisher: our signature covers the file and yours, confirming both, and never replaces yours
Community Unsigned, or self-signed

The publisher's root key is pinned in Studio. The revocation list and any rotation of the root key travel with Studio's own signed updates.

Installing and rolling back

Extensions install per user, under Studio's data folder in plugins/<id>/<version>/. The previous version is kept for one-click rollback. If a plugin is missing when a layout restores, its dock keeps a placeholder slot, so the layout doesn't shift.

to open · ↑ ↓ to move · Esc to close