Scanning for Plugins

Zrythm will scan for plugins on startup and will remember those plugins until it is closed. Zrythm supports LV2, VST2, VST3 and AU plugins. LV2 is the recommended standard.

SFZ and SF2 instruments are also supported, and they are scanned as instrument plugins.

Tip

Plugin scanning can be disabled by passing NO_SCAN_PLUGINS when running Zrythm.

LV2 Scan

Zrythm will scan for LV2 plugins in the standard paths specified here. You can bypass this behavior by passing LV2_PATH.

VST2/VST3 Scan

GNU/Linux and FreeBSD

Zrythm will scan for VST2 plugins in the following paths,

  • $HOME/.vst

  • $HOME/vst

  • /usr/local/lib/vst

  • /usr/lib/vst

and VST3 plugins in the following paths.

  • $HOME/.vst3

  • /usr/local/lib/vst3

  • /usr/lib/vst3

You can bypass this behavior by passing VST_PATH and VST3_PATH.

Note

If your system uses a libdir other than lib (for example lib64), Zrythm will scan for plugins in both locations.

Windows

Zrythm will scan for VST plugins in the paths specified in Paths.

MacOS

Zrythm will scan for VST plugins in the paths specified in VST plug-in locations on Mac OS X and macOS.

  • /Library/Audio/Plug-Ins/VST for VST2

  • /Library/Audio/Plug-Ins/VST3 for VST3

Note

Zrythm will remember scanned VST plugins and save this information in cached_plugin_descriptors.yaml in the Zrythm user path.

New plugins will be scanned on each start-up, and you can delete or edit this file to force a re-scan of previously scanned plugins.

AU Scan

On MacOS, AU plugins will be scanned at their standard location at /Library/Audio/Plug-Ins/Components.

SFZ/SF2 Scan

SFZ and SF2 instruments will be scanned in all directories and subdirectories specified in Paths.