https://github.com/tomoyanonymous/juce_cmake_vscode_example
A boilerplate for developing audio plugins with JUCE & CMake & VSCode
https://github.com/tomoyanonymous/juce_cmake_vscode_example
cmake juce vscode
Last synced: about 1 month ago
JSON representation
A boilerplate for developing audio plugins with JUCE & CMake & VSCode
- Host: GitHub
- URL: https://github.com/tomoyanonymous/juce_cmake_vscode_example
- Owner: tomoyanonymous
- Created: 2020-12-16T03:44:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T14:33:30.000Z (6 months ago)
- Last Synced: 2024-12-04T15:32:16.417Z (6 months ago)
- Topics: cmake, juce, vscode
- Language: C++
- Homepage:
- Size: 18.6 KB
- Stars: 90
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-juce - juce_cmake_vscode_example
README
# BoilerPlate Repository for developing audio plugins with JUCE & CMake & Visual Studio Code
## Requirements
- JUCE >= 6.0.0 (supports CMake after v6. Default is v8.0.4 now)
- CMake >= 3.15
- Visual Studio Code
### Recommended Extentions for vscode
- [cpptools](https://github.com/microsoft/vscode-cpptools) (basic language supports for C++ development)
- CMake (CMake language supports)
- [CMake Tools](https://github.com/microsoft/vscode-cmake-tools) (Advanced Integration for using CMake in VScode with GUI)
- [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) (better debugger than built-in gdb)
- [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) (Advanced intellisense support and formatter powered by llvm)
## Getting Started
### macOS
- Install Xcode from AppStore.
- Open "/Applications/Terminal.app".
- Type `xcode-select --install` in the terminal and hit Enter. Follow the instruction on the terminal.
- open `~/.zshrc` and add `export SDKROOT="$(xcrun --sdk macosx --show-sdk-path)"` in the last line of the file and save.
Install [homebrew](https://brew.sh/). Run `brew install cmake llvm ninja` on the terminal.
Install [Visual Studio Code](https://code.visualstudio.com/). (You can also get by `brew install --cask visual-studio-code`)
### Windows
Install Visual Studio, Visual Studio Code and Winget from Windows App Store.
Run `winget install --scope machine git cmake Ninja-build.Ninja LLVM.LLVM`.
### Common
Clone this repository.
```sh
git clone https://github.com/tomoyanonymous/juce_cmake_vscode_example --recursive
```
Or, you can create your own repository from the "Use this template" button. If you forked to your repository, replace the URL to yours.
Open `juce_cmake_vscode_example.code-workspace` with Visual Studio Code.
If the recommended extensions above are not fully installed, a notification will come up to install them.
#### 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 something like `Clang 18.1.8 x86_64_pc-windows-msvc`. Do not choose kits which start with `Visual Studio~` because they are not compatible with `clangd`.
Open CMake Menu on your left sidebar (it will show up if CMake Tools is installed).
Click "Build All Projects" on the "Project Outline".
#### Auto completion and Language server
If you use `#include ` in your code, the language server can not search JUCE library codes unless you build the project once. (`JuceHeader.h` is generated on `build/ExamplePlugin_artifacts/JuceLibraryCode`)
Note that `JuceHeader.h` is required just for the compatibility with the project generated by Projucer. So if you are going to start a project from scratch, you can just include header files relative to `lib/JUCE/modules` as you needed, like `#include `.
#### 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 v8.0.4 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.
```sh
cd lib/JUCE
git tag # show the tagged releases.
git checkout 8.0.3
# 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](https://github.com/juce-framework/JUCE/blob/master/docs/CMake%20API.md)
[sudara/pamplejuce](https://github.com/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.