VideoScoreVST

A VST plugin boilerplate built with JUCE.

Prerequisites

• CMake 3.22 or higher
• C++17 compatible compiler (MSVC, GCC, or Clang)
• JUCE framework

Setup

1. Get JUCE

You need to add JUCE as a submodule or download it:

Option A: Using Git Submodule (Recommended)

git submodule add https://github.com/juce-framework/JUCE.git JUCE
git submodule update --init --recursive

Option B: Manual Download

1. Download JUCE from https://github.com/juce-framework/JUCE
2. Extract it to a JUCE folder in the project root

2. Configure and Build

Windows (Visual Studio):

mkdir build
cd build
cmake .. -G "Visual Studio 17 2022"
cmake --build . --config Release

macOS (Xcode):

mkdir build
cd build
cmake .. -G Xcode
cmake --build . --config Release

Linux (Make):

mkdir build
cd build
cmake .. -G "Unix Makefiles"
cmake --build . --config Release

3. Output

The compiled plugin will be automatically copied to your system's plugin directories:

• Windows: %APPDATA%\VST3\ or C:\Program Files\Common Files\VST3\
• macOS: ~/Library/Audio/Plug-Ins/VST3/
• Linux: ~/.vst3/

Project Structure

VideoScoreVST/
├── CMakeLists.txt          # Build configuration
├── Source/
│   ├── PluginProcessor.h   # Audio processing logic
│   ├── PluginProcessor.cpp
│   ├── PluginEditor.h      # UI component
│   └── PluginEditor.cpp
└── README.md

Customization

Plugin Metadata

Edit CMakeLists.txt to change:

• COMPANY_NAME: Your company name
• PLUGIN_MANUFACTURER_CODE: 4-character manufacturer code
• PLUGIN_CODE: 4-character plugin code
• PRODUCT_NAME: Plugin display name

Audio Processing

Modify PluginProcessor.cpp in the processBlock() method to implement your audio processing algorithm.

User Interface

Edit PluginEditor.cpp in the paint() and resized() methods to customize the UI. You can add sliders, buttons, and other components using JUCE's component system.

Resources

• JUCE Documentation
• JUCE Tutorials
• VST Plugin Development

License

Add your license information here.