Pamplejuce is a template lifestyle for creating and building JUCE plugins in 2021.
Out of the box, it supports:
- C++20
- JUCE 6.1.5 as a submodule (tracking develop)
- CMake 3.21
- Catch2 v3 (tracking devel via FetchContent) as the test framework and runner
- GitHub Actions config for building binaries, running Catch2 tests, running pluginval and artifact building for the Windows, Linux and MacOS platforms.
It also contains:
- Proper
.gitignorefor all platforms - A
.clang-formatfile - A
VERSIONfile that will propagate through to JUCE and your app.
Read up about JUCE and CMmake on my blog!.
- MacOS code signing, packaging, notarization.
- Windows signing
This is a template repo!
That means the easiest thing to do is click "Use this template" here or at the top of the page to get your own repo with all the code here.
For an example of a plugin that uses this repo, check out Load Monster!.
After you've created a new repo:
-
git cloneyour 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 latest JUCE by running
git submodule update --initin your repository directory. By default, this will track JUCE'sdevelopbranch, which IMO is what you want until you are at the point of releasing a plugin. -
Replace
Pamplejucewith the name of your project in CMakeLists.txt line 5, where thePROJECT_NAMEvariable is set. Make this all one word, no spaces. -
Pick which formats you want built on line 8.
-
Set the correct flags for your plugin under
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_CODEandPLUGIN_MANUFACTURER_CODE. -
Rename
AudioPluginAudioProcessorto your plugin name in the code.
- Your tests will be in "Tests" and you can just add new .cpp files there.
- Your binary data target is called "Assets"
-
⚠️ GitHub gives you 2000 or 3000 free GitHub Actions "minutes" for private projects, but they actually bill 2x the number of minutes you use on Windows and 10x on MacOS. -
There's a
VERSIONfile in the root that you can treat as the main place to bump the version. -
Catch2 will update on each CMake configure, you can lock this down if you prefer by changing the
GIT_TAG.
It's very confusing, as the documentation is a big framented.
- Things in double curly braces like
${{ matrix.artifact }}are called "contexts or expressions" and can be used to get, set, or perform simple operations. - In "if" conditions you can omit the double curly braces, as the whole condition is evaluated as an expression:
if: contains(github.ref, 'tags/v') - You can set variables for the whole workflow to use in "env"
- Reading those variables is done with the env context when you are inside a
with,name, orif:${{ env.SOME_VARIABLE }} - Inside of
run, you have access to bash ENV variables in addition to contexts/expressions. That means$SOME_VARIABLEor${SOME_VARIABLE}will work but only when using bash and not while using powershell on windows. The version with curly braces (variable expansion) is often used when the variable is forming part of a larger string to avoid ambiguity. Be sure that the ENV variable was set properly in the workflow/job/step before you use it. And if you need the variable to be os-agnostic, use the env context.
When working on the template repo itself, I clear out the Builds directory when altering the CMake.
rm -rf Builds && cmake -B Builds -G Xcode
rm -rf Builds && cmake -B Builds && cmake --build Builds --config Release
- Update with latest CMake version listed here, or the latest version supported by your toolchain like VS or Clion.
- Update JUCE with
git submodule update --remote --merge - Update Xcode to latest available version and change
DEVELOPER_DIRenv var in the GitHub action.
- The "Modern CMake" gitbook which also has a section on https://cliutils.gitlab.io/modern-cmake/chapters/testing/catch.html.
- Effective Modern CMake
- JUCE's announcment of native CMake support
- Eyalamir Music's JUCE / CMake prototype repository
- Christian Adam's HelloWorld CMake and ccache repo
- Maxwell Pollack's JUCE CMake + GitHub Actions repo
- Oli Larkin's PDSynth iPlug2 template
- Running pluginval in CI