Skip to content

Latest commit

 

History

History
221 lines (196 loc) · 7.11 KB

install.md

File metadata and controls

221 lines (196 loc) · 7.11 KB

install

install.sh is the intended user-facing build/install entrypoint for local VST deployment.

Default behavior

  • configures the project in ./build
  • builds the configured targets
  • installs to ~/.vst3 by default
  • runs ctest before install by default

Environment overrides

  • DOWNSPOUT_BUILD_DIR Override the build directory.
  • DOWNSPOUT_VST3_DIR Override the VST3 install directory.
  • CMAKE_BUILD_TYPE Override the CMake build type. Default is Release.
  • DPF_ROOT Override the DPF location if you want to use an external checkout.
  • DOWNSPOUT_RUN_TESTS Set to 0 to skip ctest during install.

Linux runtime dependencies

campione — optional multi-file WAV loading uses zenity (the standard GTK file-chooser helper). On GNOME desktops it is typically pre-installed. On KDE or minimal installs, install it with:

sudo apt install zenity          # Debian / Ubuntu
sudo dnf install zenity          # Fedora
sudo pacman -S zenity            # Arch

If zenity is absent the "Load WAV(s)" button falls back to the DPF built-in single-file browser transparently — no other functionality is affected.

Linux UI build dependencies

DPF UI targets use OpenGL and DBus development headers through DistrhoUI.hpp. If an existing build tree was created before an Ubuntu upgrade, cached DPF UI objects may keep working until a UI source file changes. A later rebuild can then fail with errors such as:

fatal error: GL/gl.h: No such file or directory

On Debian/Ubuntu, install the missing development headers and rebuild:

sudo apt install libgl-dev libdbus-1-dev
cmake --build build

Release builds

Release builds are now an explicit project requirement.

Current default behavior already configures with CMAKE_BUILD_TYPE=Release. Public release packaging is handled separately by scripts/package-release.sh; see docs/release.md.

Current outputs

The CMake install declarations currently cover 100 VST3 bundles; the authoritative synchronized bundle list is checked by scripts/check-bundle-lists.sh.

  • ambo.vst3 with UI
  • arpgen.vst3 with UI
  • basilico.vst3 with UI
  • bassgen.vst3 with UI
  • bassops.vst3 with UI
  • beards.vst3 with UI
  • bore.vst3 with UI
  • bubbles.vst3 with UI
  • cadence.vst3 with UI
  • campione.vst3 with UI
  • canticle.vst3 with UI
  • chipper.vst3 with UI
  • chorale.vst3 with UI
  • clatter.vst3 with UI
  • conductor.vst3 with UI
  • counterpointer.vst3 with UI
  • damiano.vst3 with UI
  • drift.vst3 with UI
  • drumgen.vst3 with UI
  • drumkit.vst3 with UI
  • e_mix.vst3 with UI
  • fathom.vst3 with UI
  • floozy.vst3 with UI
  • flues_synth_driver.vst3 with UI
  • fresco.vst3 with UI
  • gater.vst3 with UI
  • ghost.vst3 with UI
  • glue.vst3 with UI
  • gremlin.vst3 with UI
  • gremlin_driver.vst3 with UI
  • grist.vst3 with UI
  • ground.vst3 with UI
  • guardian.vst3 with UI
  • harmonic_atlas.vst3 with UI
  • heavyverb.vst3 with UI
  • helterskelter.vst3 with UI
  • infra.vst3 with UI
  • interleaver.vst3 with UI
  • keyframe.vst3 with UI
  • ladder.vst3 with UI
  • lifeform.vst3 with UI
  • lightverb.vst3 with UI
  • loopdelay.vst3 with UI
  • luma.vst3 with UI
  • m_mix.vst3 with UI
  • magneto.vst3 with UI
  • markov.vst3 with UI
  • melgen.vst3 with UI
  • midiscribe.vst3 with UI
  • mixgen.vst3 with UI
  • mnemosyne.vst3 with UI
  • moka.vst3 with UI
  • monochord.vst3 with UI
  • mosaic.vst3 with UI
  • mouth.vst3 with UI
  • nam.vst3 with UI
  • octet.vst3 with UI
  • oracle.vst3 with UI
  • orbit.vst3 with UI
  • orchid.vst3 with UI
  • p_mix.vst3 with UI
  • paunchlad.vst3 with UI
  • plank.vst3 with UI
  • polymeter.vst3 with UI
  • pratt.vst3 with UI
  • primefold.vst3 with UI
  • prism.vst3 with UI
  • quartet.vst3 with UI
  • quefrency.vst3 with UI
  • qune.vst3 with UI
  • resonance_garden.vst3 with UI
  • retune.vst3 with UI
  • rift.vst3 with UI
  • sam.vst3 with UI
  • scope.vst3 with UI
  • sidecar.vst3 with UI
  • sieve.vst3 with UI
  • silken.vst3 with UI
  • sinevox.vst3 with UI
  • skream.vst3 with UI
  • snatch.vst3 with UI
  • spense.vst3 with UI
  • spindown.vst3 with UI
  • spliff.vst3 with UI
  • sprout.vst3 with UI
  • strata.vst3 with UI
  • syrinx.vst3 with UI
  • t_mix.vst3 with UI
  • thumper.vst3 with UI
  • tops.vst3 with UI
  • trajectory.vst3 with UI
  • treatment.vst3 with UI
  • trio.vst3 with UI
  • tuney_vst.vst3 with UI
  • voxmod.vst3 with UI
  • wheelhouse.vst3 with UI
  • whirligig.vst3 with UI
  • worms.vst3 with UI
  • xoxolo.vst3 with UI
  • zmorph.vst3 with UI

The next install-related validation is host-side confirmation that all bundles behave correctly in Release builds.

install.sh updates the VST3 bundles, but it does not modify DAW plugin caches. If a DAW still shows stale names, makers, categories, or homepage metadata after install, force that DAW to rescan VST3 plugins or clear its plugin cache. Known examples include REAPER's reaper-vstplugins64.ini and Ardour's ~/.cache/ardour*/vst cache files.

Verified behavior

The script has been smoke-tested with a temporary install root under /tmp:

  • configure
  • build
  • test
  • install
  • confirmed bassgen.vst3 bundle output and install
  • confirmed p_mix.vst3 bundle output and install
  • confirmed e_mix.vst3 bundle output and install
  • confirmed m_mix.vst3 bundle output and install
  • t_mix.vst3 is newly added and awaits host-side install validation
  • confirmed melgen.vst3 bundle output and install
  • confirmed rift.vst3 bundle output and install
  • confirmed orchid.vst3 bundle output and install
  • confirmed ambo.vst3 bundle output and install
  • confirmed drumgen.vst3 bundle output and install
  • confirmed drumkit.vst3 bundle output and install
  • confirmed cadence.vst3 bundle output and install
  • confirmed arpgen.vst3 bundle output and install
  • confirmed counterpointer.vst3 bundle output and install
  • confirmed sidecar.vst3 bundle output and install
  • confirmed gremlin.vst3 bundle output and install
  • confirmed gremlin_driver.vst3 bundle output and install
  • confirmed ground.vst3 bundle output and install
  • confirmed floozy.vst3 bundle output and install
  • confirmed basilico.vst3 bundle output and install
  • confirmed canticle.vst3 bundle output and install
  • confirmed luma.vst3 bundle output and install
  • confirmed paunchlad.vst3 bundle output and install
  • confirmed lifeform.vst3 bundle output and install
  • plank.vst3 builds locally and awaits host-side install validation
  • pratt.vst3 builds locally (VST3 and JACK standalone) and awaits host-side install validation
  • retune.vst3 builds locally (VST3 and JACK standalone) and awaits host-side install validation
  • sprout.vst3 builds locally (VST3 and JACK standalone) and awaits host-side install validation
  • markov.vst3 builds locally (VST3 and JACK standalone) and awaits host-side install validation
  • confirmed xoxolo.vst3 bundle output and install
  • confirmed syrinx.vst3 bundle output and install
  • confirmed tuney_vst.vst3 bundle output and install
  • bore.vst3 builds locally; host-side install validation remains
  • the ten generative-workstation bundles build locally and await broad host-side install validation