Tip

The Quickstart / Web section achieves the same result without having to install anything locally.

Clone the Jamba repository

Clone the Jamba repository in a location of your choice (referred to as JAMBA_REPO_DIR). This gives access to the blank plugin files and create-plugin.py script.

Install python3 (if not installed)

The create-plugin.py script requires python3 to run so you need to install it if you don’t already have it (note that the latest version of macOS 10.13.6 still comes with python2).

Generate the skeleton plugin

From a directory of your choice, run the following command:

python3 <JAMBA_REPO_DIR>/create-plugin.py

Follow the prompt (example run)

> cd /tmp
> python3 /Volumes/Development/github/org.pongasoft/jamba/create-plugin.py
Plugin Name (must be a valid C++ class name) = Kooza
Enable Audio Unit (Y/n)?
macOS deployment target (leave empty for default [10.14]) =
Audio Unit manufacturer code (4 chars / one capital letter) (leave empty for default [Kooz]) =
Filename (leave empty for default [Kooza]) =
Company (leave empty for default [acme]) =
Company URL (leave empty for default [https://www.acme.com]) =
Company Email (leave empty for default [support@acme.com]) =
C++ namespace (leave empty for default [acme::VST::Kooza]) =
Download VST SDK (Y/n)?
Project directory (leave empty for default [/private/tmp]) =
Project Name (leave empty for default [acme-Kooza-plugin]) =
##################
Plugin Name        - Kooza
macOS Target       - 10.14
Audio Unit Enabled - ON
AU Plugin Code     - Kooz
Filename           - Kooza (will generate Kooza.vst3)
Company            - acme
Company URL        - https://www.acme.com
Company Email      - support@acme.com
Jamba git hash     - v7.0.0
C++ Namespace      - acme::VST::Kooza
Dowload VST SDK    - ON
Plugin root dir    - /private/tmp/acme-Kooza-plugin

Are you sure (Y/n)?
Generating Kooza plugin....
Kooza plugin generated under /private/tmp/acme-Kooza-plugin
You can now configure the plugin:

For macOs:
----------
### configuring

cd <build_folder>
/private/tmp/acme-Kooza-plugin/configure.py

### building, testing, etc...
cd <build_folder>/build
./jamba.py -h

For Windows 10:
---------------
### configuring

cd <build_folder>
python /private/tmp/acme-Kooza-plugin/configure.py

### building, testing, etc... (PowerShell recommended)
cd <build_folder>/build
python ./jamba.py -h

The plugin generated will have content similar to this

CMakeLists.txt
LICENSE.txt
README.md
archive/README-macOS_64bits.txt
archive/README-win_64bits.txt
audio-unit/Info.plist
audio-unit/audiounitconfig.h
configure.bat*
configure.sh*
jamba.cmake
mac/Info.plist
resource/Kooza.rc
resource/Kooza.uidesc
src/cpp/GUI/KoozaController.cpp
src/cpp/GUI/KoozaController.h
src/cpp/Kooza.h
src/cpp/KoozaCIDs.h
src/cpp/Kooza_VST3.cpp
src/cpp/RT/KoozaProcessor.cpp
src/cpp/RT/KoozaProcessor.h
src/cpp/version.h.in
test/cpp/test-Kooza.cpp
vst369.cmake

Next Steps

You can now follow Step 2 to configure and build the plugin