@@ -12,7 +12,7 @@ This is what the plugin looks like:
1212
1313Concepts
1414--------
15- Jamba is a set of helpers (classes, concepts, build files, etc...) built on top of the VST SDK to provide a lightweight framework to build a VST2/3 plugin.
15+ Jamba is a set of helpers (classes, concepts, build files, etc...) built on top of the VST SDK to provide a lightweight framework to build a VST3 plugin.
1616
1717### Parameters
1818VST parameters are what the host DAW deal with (for example a knob is usually tied to a VST parameter). Both the GUI and the RT (Real Time) are "sharing" those parameters. As a result Jamba makes them front and center: you define them in one place and use them in the GUI and RT. Check the file [ JSGainPlugin.h] ( src/cpp/JSGainPlugin.h )
@@ -99,91 +99,86 @@ The following steps describes how to build the plugin:
9999
100100### macOS:
101101
102- - For simplicity I am creating the build at the root of the source tree, but can obviously be * outside* the source tree entirely by running the script from anywhere
102+ - For simplicity, I am creating the build at the root of the source tree, but can obviously be * outside* the source tree entirely by running the script from anywhere
103103
104104 > ./configure.py -h
105- usage: configure.py [-h] [-n] [-f] [-r] [--vst3 VST3_SDK_ROOT] [--vst2 VST2_SDK_ROOT]
106- [-G GENERATOR] [-B BUILD_DIR] [-- <cmake_options>]
105+ usage: configure.py [-h] [-n] [-f] [-r] [--vst3 VST3_SDK_ROOT] [-G GENERATOR] [-B BUILD_DIR] [-- <cmake_options>]
107106
108107 positional arguments:
109- cmake_options Any options for cmake
108+ cmake_options Any options for cmake
110109
111110 optional arguments:
112- -h, --help show this help message and exit
113- -n, --dry-run Dry run (prints what it is going to do)
114- -f, --force Force a regeneration (delete and recreate build folder)
115- --vst3 VST3_SDK_ROOT Path to the VST3 SDK (optional)
116- --vst2 VST2_SDK_ROOT Path to the VST2 SDK (optional)
117- -r, --release Use CMake Release build type (for single-config generators)
118- -G GENERATOR, --generator GENERATOR
119- CMake generator (optional)
120- -B BUILD_DIR, --build-dir BUILD_DIR
121- Build folder (defaults to ./build)
111+ -h, --help show this help message and exit
112+ -n, --dry-run Dry run (prints what it is going to do)
113+ -f, --force Force a regeneration (delete and recreate build
114+ folder)
115+ --vst3 VST3_SDK_ROOT Path to the VST3 SDK (optional)
116+ -r, --release Use CMake Release build type (for single-config
117+ generators)
118+ -G GENERATOR, --generator GENERATOR
119+ CMake generator (optional)
120+ -B BUILD_DIR, --build-dir BUILD_DIR
121+ Build folder (defaults to ./build)
122122
123123 Notes
124- ---vst3 defaults to /Users/Shared/Steinberg/VST_SDK.<JAMBA_VST3SDK_VERSION>
125- ---vst2 defaults to /Users/Shared/Steinberg/VST_SDK.<JAMBA_VST2SDK_VERSION>
124+ ---vst3 defaults to /Users/Shared/Steinberg/VST_SDK.<JAMBA_VST3SDK_VERSION>
126125
127- -G defaults to "Xcode" on macOS and "Visual Studio 16 2019" for Windows10
128- run 'cmake --help' to get the list of generators supported
126+ -G defaults to "Xcode" on macOS and "Visual Studio 16 2019" for Windows10
127+ run 'cmake --help' to get the list of generators supported
129128
130- For single-config generators, Debug is used by default and can be changed with -r for Release
131- For multi-config generators, -r is ignored
129+ For single-config generators, Debug is used by default and can be changed with -r for Release
130+ For multi-config generators, -r is ignored
132131
133- To provide extra options to CMake you do it this way
134- python3 configure.py -- -Wdev
132+ To provide extra options to CMake you do it this way
133+ python3 configure.py -- -Wdev
135134
136135 Examples
137- # Specify an explicit path to the VST3 sdk and uses default generator
138- python3 configure.py ---vst3 /opt/local/VST_SDK.3.7.0
136+ # Specify an explicit path to the VST3 sdk and uses default generator
137+ python3 configure.py ---vst3 /opt/local/VST_SDK.3.7.0
139138
140- # Use default paths and uses another generator
141- python3 configure.py -G "CodeBlocks - Unix Makefiles"
139+ # Use default paths and uses another generator
140+ python3 configure.py -G "CodeBlocks - Unix Makefiles"
142141
143- # Use defaults
144-
145- > ./configure.py
146- > cd build
142+ # Use defaults
143+ python3 configure.py
147144
148- - In order to build, test, validate, etc... simply use the ` jamba.sh ` script like this:
145+ - In order to build, test, validate, etc... simply use the ` jamba.sh ` script like this:
149146
150- > ./jamba.sh -h
151- usage: jamba.sh [-hnvbdr] <command> [<command> ...] [-- [native-options]]
147+ > ./jamba.sh -h
148+ usage: jamba.sh [-hnvbdr] <command> [<command> ...] [-- [native-options]]
152149
153- positional arguments:
150+ positional arguments:
154151 command See "Commands" section
155152
156- optional arguments:
153+ optional arguments:
157154 -h, --help show this help message and exit
158155 -n, --dry-run Dry run (prints what it is going to do)
159156 -v, --verbose Verbose build
160157 -b, --banner Display a banner before every command
161158 -d, --debug use Debug build config
162159 -r, --release use Release build config
163160
164- Commands
161+ Commands [Debug]
165162 ---- Main commands ----
166163 clean : clean all builds
167164 build : build the plugin
168165 test : run the tests for the plugin
169166 validate : run the validator for the vst3 plugin
170167 edit : run the editor (full editing available in Debug config only)
171- install : build and install all the plugins (vst2/vst3/audio unit)
172- uninstall : delete the installed plugins (vst2/vst3/audio unit)
168+ info : run the module info tool (display json info about the plugin)
169+ inspect : run the inspector (inspects ALL installed plugins)
170+ install : build and install all the plugins (vst3/audio unit)
171+ uninstall : delete the installed plugins (vst3/audio unit)
173172 archive : create an archive containing the plugins
174173
175174 ---- VST3 commands ----
176175 install-vst3 : install the vst3 plugin only
177176 uninstall-vst3 : uninstall the vst3 plugin only
178177
179- ---- VST2 commands ----
180- install-vst2 : install the vst2 plugin only
181- uninstall-vst2 : uninstall the vst2 plugin only
182-
183178 ---- Audio Unit commands ----
184- build-au : builds the Audio Unit wrapper
185- install-au : install the vst2 plugin only
186- uninstall-au : uninstall the vst2 plugin only
179+ build-au : builds the Audio Unit only
180+ install-au : install the Audio Unit only
181+ uninstall-au : uninstall the Audio Unit only
187182
188183 ---- CMake target ----
189184 <command> : Any unknown <command> is treated as a cmake target
@@ -203,6 +198,9 @@ For windows, follow the same steps for macOS with the following changes:
203198Release Notes
204199-------------
205200
201+ ### 2023-05-25 - ` v2.0.0 `
202+ * use latest version of Jamba (v7.0.0) / removed support for VST2
203+
206204### 2022-06-02 - ` v1.2.9 `
207205* use latest version of Jamba (v6.0.1) to fix gtest crash on Apple M1
208206
0 commit comments