MPC VST · field notes

Release · licence · catalog

Ship

Shipping is four artefacts and one decision: what licence the code must have. Then a pull request with one JSON file.

The four artefacts

ArtefactMade byNotes
the plugin folderyour build.so + skin + version.xml
one ziptools/release.pyinstaller, uninstaller, INSTALL.md, manifest, SHA256SUMS
tested.jsonyoudevice, firmware, date — this is what makes a listing “Verified”
catalog entrya PRcatalog/plugins/<id>.json, no versions or checksums inside

Version numbers are a convention, not a style

vst.json carries an integer: 1010 is 1.0.1 (major*1000 + minor*100 + patch*10). Get it wrong and the release says 1.0.0 while the plugin inside says 1.0.1 — nobody notices until a bug report quotes the wrong version.

Licence decides what you can publish

Release, without gh

# tag + release
POST /repos/<owner>/<repo>/releases          {"tag_name":"v1.0.1","name":"…","body":"…"}
# asset
POST https://uploads.github.com/repos/<owner>/<repo>/releases/<id>/assets?name=<zip>
# verify the upload against your local hash
sha256sum dist/<zip>     ==     the "digest" the API returns

Releases are immutable in practice: never re-upload under an existing tag, cut a new one.

Before anything becomes public

The catalog PR

{ "id": "mpc-multihead-echo", "name": "MPC Multihead Echo", "author": "you",
  "repo": "you/mpc-vst-multihead-echo", "kind": "effect", "license": "GPL-3.0-only",
  "summary": "One line, descriptive.",
  "screenshot": "https://raw.githubusercontent.com/you/…/<commit>/docs/panel.png",
  "style": "delay", "tags": ["tape-echo","delay"] }

Validate it locally first: python3 tools/catalog_build.py --check-registry and python3 tools/catalog_check.py <zip> --catalog. Then one PR adding that file. CI checks the entry and your latest release; new releases appear on their own afterwards.

The one warning you will get

catalog_check flags a .so that calls socket/bind/accept. If that is the companion screen, say so in the release notes and the PR: what it serves, that it never sends anything outbound, and which environment switch turns it off. An explained warning is not a problem; an unexplained one is a question the maintainer has to ask.

What a good listing says

Next: agents →