BoilerPlate Repository for developing audio plugins with JUCE & CMake & Visual Studio Code

Requirements

• JUCE >= 6.0.0 (supports CMake after v6.)
• CMake >= 3.15
• Visual Studio Code

Also, clangd a language server for C++ is highly recommended. In macOS, you can install with brew install llvm.

Ninja is also recommended for fast build (will be used automatically if present in this repository. You can change priority of generators in cmake.preferredGenerators in workspace setting).

Recommended Extentions for vscode

• cpptools (basic language supports for C++ development)
• CMake (CMake language supports)
• CMake Tools (Advanced Integration for using CMake in VScode with GUI)
• CodeLLDB (better debugger than built-in gdb)
• clangd (Advanced intellisense support and formatter powered by llvm)

Getting Started

macOS

Install Xcode and type xcode-select --install in terminal. open ~/.zshrc and add export SDKROOT="$(xcrun --sdk macosx --show-sdk-path)" in the last line of the file.

Windows

Install Visual Studio.

common

Clone this repository.

git clone https://github.com/tomoyanonymous/juce_cmake_vscode_example --recursive

Open juce_cmake_vscode_example.code-workspace with Visual Studio Code. If recommended extensions are not fully installed, notification to install them will come up.

Build

If CMake Tools is correctly installed, you will be asked which CMake Kits(compiler) you want to use.

In macOS, choose Clang x.x.x which point to /usr/bin/clang++ (clang provided by xcode. of course you can choose other compilers if you have).

In Windows, choose Visual Studio Community 2019 Release - amd64, you will have choices of architectures(like amd64/x86-amd64).

Open CMake Menu on your left sidebar (it will show up if CMake Tools is installed).

Click "Build All Projects".

Debugging

If successfully built, right click JUCE_CMAKE_EXAMPLE/src/ExamplePlugin_Standalone and select "set as Debug/Launch Target".

Open Debug Menu in left Sidebar. And click Run button on the left in a menu of CMake Debug(workspace). Standalone version of your plugin will be launched.

(Note that you can also debug from "Debug" button in right-click menu of CMake Tools but you cannot use CodeLLDB debugger in this case.)

(Optional) Setting JUCE version.

The version of JUCE is v7.0.3 by default currently. Juce is located as a git submodule in lib directory, so you can switch the version by checking out in the directory like this.

cd lib/JUCE
git tag # show the tagged releases.
git checkout 7.0.2
# If you need, you can commit the change of JUCE version in the main directory.
cd ..
git commit -m "Changed the version of JUCE."

Resources

JUCE CMake API Documents

sudara/pamplejuce another great template repository for developing JUCE with CMake + Catch2 + GitHub Actions + C++20

License

(c) Tomoya Matsuura https://matsuuratomoya.com

All of source codes included in this repository are published under MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

All of documents included in this repositry are published under Creative Commons Attribution 4.0 International License.