Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
This tutorial explains how to set up your computer and create an environment for compiling the VST 3 audio plug-in examples provided with the VST 3 SDK.

These include plug-ins like simple DSP effects (Gain, compressor, delay,...), synths instruments and some plug-ins showing how to handle some specific VST 3 features (Note Expression, Program Change, channel info context,...).

They can be loaded into VST 3 hosts like Cubase, WaveLab, ...


Part 1: Getting and installing the VST3 SDK

For downloading the SDK, see this section "How to set up my system for VST 3".

Download cmake from: https://cmake.org/download/ or use a package manager for your OS.


Part 2: Building the examples

Building the examples on Linux

  • Create a folder for the build and move to this folder (using cd):
Code Block
mkdir build

cd build


  • Generate the solution/projects: specify the path to the project where CMakeLists.txt is located:
Code Block
cmake ../vst3sdk


  • Build the plug-in:
Code Block
make
(or alternatively for example for release)

cmake --build . --config Release


Building the examples on macOS

  • Create a folder for the build and move to this folder (using cd):
Code Block
mkdir build

cd build

  • Generate the solution/projects: specify the path to the project where CMakeLists.txt is located:
    For XCode:
Code Block
cmake -GXcode ../vst3sdk


Without XCode (here debug variant):

Code Block
cmake -DCMAKE_BUILD_TYPE=Debug ../


  • Build the plug-in (you can use XCode too):
Code Block
xcodebuild
 (or alternatively for example for release)

cmake --build . --config Release

Building the examples on Windows

  • Create a folder for the build and move to this folder (using cd):
Code Block
mkdir build

cd build


  • Generate the solution/projects: specify the path to the project where CMakeLists.txt is located:
Code Block
cmake.exe -G "Visual Studio 16 2019" -A x64 ../vst3sdk
  or
cmake.exe -G "Visual Studio 15 2017" -A x64 ../vst3sdk
  or
cmake.exe -G "Visual Studio 15 2017" -A Win32 ../vst3sdk


Note: you can find the string definition for different Visual Studio Generators in the cmake online documentation (https://cmake.org/documentation/)

  • Build the plug-in (you can use Visual Studio too):
Code Block
msbuild.exe vstsdk.sln
 (or alternatively for example for release)

cmake --build . --config Release

Building using cmake-gui

  • Start the cmake-gui application which is part of the cmake installation (https://cmake.org/download/)

  • "Browse Source...": select the folder VST3_SDK
  • "Browse Build...": select a folder where the outputs (projects/...) will be created. Typically a folder named "build"
  • you can check the SMTG Options
  • Press "Configure" and choose the generator in the window that opens: for example "Visual Studio 16 2019"

  • Press "Generate" to create the project
  • Open your targeted IDE, and compile the solution/project.



Panel

On this page:

Table of Contents
maxLevel2
indent25px