After you’ve created a new repo from the template, you have a checklist of things to do to customize for your project.
git clone
your new repo (if you make it private, see the warning below about GitHub Actions minutes)- Download CMAKE if you aren’t already using it (Clion and VS2022 both have it bundled, so you can skip this step in those cases).
- Populate the JUCE by running
git submodule update --init
in your repository directory. By default, this will track JUCE’sdevelop
branch, which is a good default until you are at the point of releasing a plugin. It will also pull in the CMake needed and an example module, my component inspector. - Replace
Pamplejuce
with the name of your project inCMakeLists.txt
where thePROJECT_NAME
variable is first set. Make this all one word, no spaces. - Adjust which plugin formats you want built as needed (VST3, AU, etc).
- Set the correct flags for your plugin
juce_add_plugin
. Check out the API https://github.com/juce-framework/JUCE/blob/master/docs/CMake%20API.md and be sure to change things likePLUGIN_CODE
andPLUGIN_MANUFACTURER_CODE
and everything that saysChange me!
. - Build n’ Run! If you want to generate an Xcode project, run
cmake -B Builds -G Xcode
. Or just open the project in CLion or VS2022. Running the standalone might be easiest, but you can also build theAudioPluginHost
that comes with JUCE. Out of the box, Pamplejuce’s VST3/AU targets should already be pointing to it’s built location. - If you want to package and code sign, you’ll want to take a look at the packaging/ directory add assets and config that match your product. Otherwise, you can delete the GitHub Action workflow steps that handle packaging (macOS will need code signing steps to work properly).
This is what you will see when it’s built, the plugin displaying its version number with a button that opens up the Melatonin Inspector:
Leave a Reply