Skip to content
DOCS

Build your plugin

Build your plugin locally, choose its formats, let Auto Build keep up with changes, and fix failed builds.

BuildLink to this section

Click Build in the project's action bar, or press ⌘B (Ctrl+B on Windows). The Output panel at the bottom shows the build as it runs, and a toast says whether it worked.

The first build of a project is the slowest; later ones reuse earlier work. Local builds are always release builds.

When a build failsLink to this section

The Output panel shows the error. With an agent set up, Fix It sends the error to the agent to fix; build again once it's done.

If a build seems stuck on old code, use the arrow beside Build:

  • Clean Build builds once from scratch.
  • Never cache for this project makes every build start from scratch.

Auto BuildLink to this section

Turn on Auto Build (Auto in the Editor view) to build each time the agent makes a new version. In the Editor view it also builds when you save a source file. Each view has its own switch in Project Settings, Build.

FormatsLink to this section

FrameworkFormats
NIH-plugVST3, CLAP
JUCEVST3, CLAP, AU (macOS), Standalone
iPlug2VST3, CLAP, AU (macOS), Standalone (with a custom interface)

VST3 and CLAP are always built: Studio's preview plays the CLAP. Choose the others per project in Project Settings, Build, Build formats. Settings, Local Build, Build Formats sets the formats new projects start with.

Where builds goLink to this section

Each build goes in its own folder, one per version: ~/Freqlab/output/<project>/v<N>/ (%USERPROFILE%\Freqlab\output\... on Windows). Click Open Build Folder on the project's home page to see it.

Studio keeps each project's newest 30 builds, plus the version you're on and any you've named. Change how many in Settings, Local Build, Old Builds.

Custom build commandsLink to this section

In Project Settings, Build:

  • CMake arguments or Cargo arguments add to Studio's own build steps.
  • For a project with its own build steps, Custom commands and output folder has Configure command and Build command, which replace Studio's steps, and Output directory, where your build writes its plugins (inside the project). Commands split on spaces: quoted arguments aren't supported, so use a script for anything more.