Plugin screenshots for GitHub Pages are generated from the real DPF UI code, not from mockups.
Use:
scripts/capture-plugin-screenshots.shBy default this:
- configures
build/screenshotswithDOWNSPOUT_BUILD_SCREENSHOT_APPS=ON; - builds DPF standalone UI targets for all plugins;
- starts a temporary
jackd -d dummyserver when no JACK server is already running, so screenshots do not require an audio device; - launches each UI under Xvfb when no
DISPLAYis already available; - captures each window with ImageMagick;
- writes PNGs to
docs/pages/assets/plugins/. - exports
DOWNSPOUT_SCREENSHOT_DEMO=1. A standalone has no audio, so a panel that only means something with signal (currentlysinevox, whose plot is the tracked formants) reads this and shows sample data. Hosts never set it.
To capture only selected plugins:
scripts/capture-plugin-screenshots.sh bassgen drumgen drumkitTo reuse an existing screenshot build:
scripts/capture-plugin-screenshots.sh --skip-buildThe reused build must have been configured with
DOWNSPOUT_BUILD_SCREENSHOT_APPS=ON, because screenshot builds enable DPF's
standalone UI target.
The script expects:
- CMake
- Xvfb when running headless
- JACK tools, usually
jackd2 - either
xdotoolor thexwininfo/xproptools fromx11-utils - ImageMagick
import
On Debian/Ubuntu:
sudo apt install jackd2 xvfb xdotool x11-utils imagemagickCurrent output filenames:
bassgen.pngp-mix.pnge-mix.pngm-mix.pngt-mix.pngmixgen.pngloopdelay.pnglightverb.pngmelgen.pngrift.pngorchid.pngdrumgen.pngdrumkit.pngxoxolo.pngcadence.pngarpgen.pngcounterpointer.pngsidecar.pnggremlin.pnggremlin-driver.pngground.pngambo.pngfloozy.pngbasilico.pngcanticle.pngmagneto.pngbeards.pngtrajectory.pngbore.pngfathom.pngqune.pngprism.pngmouth.pnggrist.pngsam.pngladder.pngglue.pngoctet.pngtrio.pnginfra.pngspindown.pngwheelhouse.pngwhirligig.pngchorale.pngsilken.pngfresco.pngstrata.pngquartet.pngmonochord.pngnam.pngthumper.pngsnatch.pngtops.pngclatter.pngspense.pngheavyverb.pnginterleaver.pngprimefold.pngquefrency.pngkeyframe.pngmoka.pngluma.pngpaunchlad.pnglifeform.pngplank.pngpratt.pngretune.pngsprout.pngmarkov.pngsyrinx.pngtuney-vst.pngvoxmod.pngsinevox.pngsieve.pngzmorph.png
This list is out of date in places: it predates several plugins, and
docs/pages/_products/*.md is the authoritative record of which catalog
entries carry a screenshot. Add new capture targets to
scripts/capture-plugin-screenshots.sh and the product page's screenshot:
front matter together, not just here.
The output path can be overridden:
DOWNSPOUT_SCREENSHOT_OUTPUT_DIR=docs/site/assets/plugins scripts/capture-plugin-screenshots.shThe GitHub Pages source lives under docs/pages/. Plugin pages are Markdown
files in docs/pages/_products/, and each page references one of the generated
screenshots in docs/pages/assets/plugins/.