musiikki/nih-plug-template
Template
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: correct bundle output paths and add Linux prerequisites

Browse Source 
Two things in the build instructions were wrong rather than merely thin.

The stated output paths (`nih_plug_template.vst3`) are not what the
bundler produces: `cargo xtask bundle` names artifacts from the `name` key
in bundler.toml, so a fresh clone actually yields `Plugin Name.vst3`.
Anyone following the deploy steps verbatim would copy a path that does not
exist. The VST3 artifact is also a directory bundle, so the `cp` needed
`-r` to work at all.

The egui editor pulls in baseview and x11, whose build scripts abort on a
missing `gl.pc` with a pkg-config error that says nothing about this
project. Naming the packages up front turns a confusing first-build
failure into a one-line fix.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WHt4DykxXaQnyaJfyS8KCn
This commit is contained in:
Mikkeli Matlock
2026-08-29 10:23:59 +09:00
parent dd5cedfa92
commit fc45d3eec0
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -5
View File
@@ -25,7 +25,16 @@ cd my-plugin
cargo xtask bundle nih_plug_template --release
```
**Output:** `target/bundled/nih_plug_template.vst3` and `nih_plug_template.clap`
**Output:** `target/bundled/<name>.vst3` and `<name>.clap`, where `<name>` is the `name` set
in `bundler.toml` — **not** the crate name. Out of the box that means
`target/bundled/Plugin Name.vst3`.
On Linux the egui editor needs the GUI development headers:
```bash
sudo apt install pkg-config libgl-dev libx11-dev libxcursor-dev libxcb1-dev \
libxcb-icccm4-dev libxcb-dri2-0-dev libx11-xcb-dev libxkbcommon-dev libxkbcommon-x11-dev
```
## Deploy
@@ -42,14 +51,14 @@ FL Studio scans `C:\Program Files\Common Files\VST3` by default, **ignores direc
```bash
# VST3
cp target/bundled/nih_plug_template.vst3 ~/.vst3/
cp -r "target/bundled/Plugin Name.vst3" ~/.vst3/
# CLAP
cp target/bundled/nih_plug_template.clap ~/.clap/
cp -r "target/bundled/Plugin Name.clap" ~/.clap/
# Or globally:
# sudo cp target/bundled/nih_plug_template.vst3 /usr/lib/vst3/
# sudo cp target/bundled/nih_plug_template.clap /usr/lib/clap/
# sudo cp -r "target/bundled/Plugin Name.vst3" /usr/lib/vst3/
# sudo cp -r "target/bundled/Plugin Name.clap" /usr/lib/clap/
```
## Project Structure