Custom Module Example
The Custom Module Example shows how to bring your own C++ DSP algorithms into Gorilla Engine instruments and effects. It is included in the Enterprise flavour of the SDK, under Examples/Custom Module Example.
What the Example Demonstrates
Section titled “What the Example Demonstrates”- EffectExample processes an effect bus with gain and a left-channel-only option.
- FilterExample processes audio in a group’s voice signal path and provides a meter output.
- FilterExampleOsc demonstrates generating audio in a voice module.
- FilterExampleModSource demonstrates a custom modulation source.
The examples share parameter descriptors and the module interfaces used by the engine. Their library exports listModules() to advertise available modules and createModule() to construct them.
Project Layout
Section titled “Project Layout”| Directory | Contents |
|---|---|
src |
CustomModuleExample.cpp, the CMake project, and build instructions. |
custom-module-sdk |
The effect, filter, parameter, and module interfaces, plus the supporting SDK library. |
On macOS, the default installed location is /Applications/Gorilla Engine SDK/Examples/Custom Module Example. Keep src and custom-module-sdk together when copying the example, or configure CUSTOM_MODULE_SDK_DIR to point to the SDK directory.
Build and Use the Example
Section titled “Build and Use the Example”This is a native C++ project, not a Gorilla Engine React project. It uses CMake rather than npm ci or npm run buildAndInstall. From its src directory:
cmake -B buildcmake --build build --config ReleaseUse CMake 3.18 or newer and a suitable C++ compiler. The output is a .dylib on macOS or a .dll on Windows. Its architecture must match the Editor or plugin that loads it.
Follow Custom DSP Modules for a code walkthrough, installing the library in Gorilla Editor, and shipping it through Gorilla Compiler → Packaging → Native Plugins. Installing the example in the Editor alone does not include it in your product.