Wrong documentation on CMake API VST3_CATEGORIES?

tomoyanonymous · December 11, 2020, 7:35am

juce-framework/JUCE/blob/develop/docs/CMake API.md#juce_add_target

# The JUCE CMake API

## System Requirements

- Console and GUI projects require CMake 3.12 or higher.
- Plugin projects require CMake 3.15 or higher.
- All iOS targets require CMake 3.14 or higher (3.15 or higher for plugins targeting iOS).
- Android targets are not currently supported.
- WebView2 on Windows via JUCE_USE_WIN_WEBVIEW2 flag in juce_gui_extra is not currently supported.

Most system package managers have packages for CMake, but we recommend using the most recent release
from https://cmake.org/download. You should always use a CMake that's newer than your build
toolchain, so that CMake can identify your build tools and understand how to invoke them.

In addition to CMake you'll need a build toolchain for your platform, such as Xcode or MSVC.

## Getting Started

### Using `add_subdirectory`

This file has been truncated. show original

- `VST3_CATEGORIES`

  - Should be one or more, separated by spaces, of the following: Fx, Instrument, Analyzer, Delay, Distortion, Drum, Dynamics, EQ, External, Filter, Generator, Mastering, Modulation, Mono, Network, NoOfflineProcess, OnlyOfflineProcess, OnlyRT, Pitch Shift, Restoration, Reverb, Sampler, Spatial, Stereo, Surround, Synth, Tools, Up-Downmix

The delimiter should be a semicolon, not a space right?

According to the function _juce_get_vst3_category_string on the line 1445 in extras/Build/CMake/JUCEUtils.cmake

string(REGEX REPLACE ";" "|" result "${vst3_categories}")

When I separated with spaces, the category shown in hosts was like Fx | <One Long Concatenated String Category>. Tested on Max 8 and Nuendo 10.

McMartin · December 13, 2020, 9:35pm

What exactly are you passing to juce_add_plugin?

Something like:

A
```
  VST3_CATEGORIES Drum Sampler
```
B
```
  VST3_CATEGORIES "Drum" "Sampler"
```
C
```
  VST3_CATEGORIES "Drum Sampler"
```
D
```
  VST3_CATEGORIES "Drum;Sampler"
```

The expected syntax, as described in the documentation, is A.
B is technically equivalent.
D is not recommended, but should also work.
C won’t work.

tomoyanonymous · December 14, 2020, 4:59am

Ah, I was trying C and switched to D. Thank you.

Site navigation

Wrong documentation on CMake API VST3_CATEGORIES?

Further Information