ZMANN

Explore a range of instruments, designed to elevate your audio production experience.

[!IMPORTANT]
We are currently working hard to finalize the release date for our product. Stay tuned for updates as we will be announcing the release date very soon. Thank you for your patience and support!

Plugins

As defined in bundler.toml, the following plugins are included in this repository, for more information on each plugin, please refer to their respective product pages on zmann.org.

Product	CI/CD	TYPE
Toybox C1200
Orchestron
Bilhorn Reed
Hohner Melodica
Mellotron
NoiseG8

Installation

After downloading the .vst3 file, move it to your VST3 directory. The default VST3 directory is located at C:\Program Files\Common Files\VST3 on Windows. If you are unsure where your VST3 directory is located, you can check the VST3 directory in your DAW's settings.

[!TIP] Create a dedicated folder within your VST3 directory, e.g., ZMANN, for better organization.

Table of Contents

• Plugins
• Installation
• Demo
• Documentation
• Building
  • Prerequisites
  • Building the plugins
  • Cross-compiling
• Acknowledgments

Building

[!WARNING]
As of writing, only Windows is supported for building. Linux cross-compilation might work, but is not stable at this time. Currently we don't have any motivation in supporting Mac OS, although the plugins should be compatible without many modifications. Read more about cross-compilation.

Prerequisites

• Node.js 18.17 or later
• Rust

Windows

Before building, make sure that rustup is installed with msvc if building on Windows:

$ rustup default stable-x86_64-pc-windows-msvc

Adding the artifacts

As of writing, we aren't including the samples (for example .binv5 or .microbin) in the repository due to the git file limit. For the builds not to fail, supply a /samples/plugin_name folder, where plugin_name is the name of the plugin you are building. You can create the folder by running:

$ mkdir /samples/plugin_name

Then, add the samples to the folder. The folder structure should look like this:

/samples
  /Toybox_C1200
    /Cello.binv5

Release builds will be built with the samples included in the plugin bundle.

Building the plugins

Plugins are required to be built separately from each other. Run the xtask build command with the plugin name and --release at the end to target a release build. For example:

$ cargo xtask bundle toybox_c1200 --release

Cargo will now build the toybox_c1200_ui before building the plugin itself. After successfully building, each plugin will make their own .vst3 bundle inside of the /target/bundled/ folder.

Or to build all projects inside of the repository, run to build all the ui and plugins in the repository:

$ cargo xtask bundle -p toybox_c1200 -p orchestron 

Optionally by running mklink on Windows, a simlink will be created from the locally generated artifacts folder to the standard vst3 folder to streamline development. This will allow you to test the plugins in your DAW without having to move the files manually. Run the following command in the root of the repository:

mklink /j "%COMMONPROGRAMFILES%\VST3\zmann-dev" "%~dp0target\bundled\"

Cross-Compiling

Debian/Ubuntu

Make sure to install the following package and toolchain:

$ sudo apt install build-essential
$ rustup target add x86_64-pc-windows-gnu

After installing the toolchain, modify .cargo/config.toml to use the x86_64-pc-windows-gnu toolchain:

[alias]
xtask = "run --package xtask --target x86_64-pc-windows-gnu --release --"

Finally, you can build the plugins by running the following command:

$ cargo xtask bundle plugin_name

Acknowledgments

• nih-plug-webview (Modified)

  • Original Library: nih-plug-webview
  • License: ISC

• fx (Modified)

  • Original Library: renzol2/fx
  • License: GPLv3

• nih-plug (Integrated)

  • Original Library: nih-plug
    • The framework is licensed under the ISC license.
    • The VST3 bindings used by nih_export_vst3!() are licensed under the GPLv3 license. This implies that unless you replace these bindings with your own bindings made from scratch, any VST3 plugins built in this repository need to comply with the terms of the GPLv3 license.

The code in this repository is licensed under the GNU General Public License v3.0 or later. You can find a copy of the license in the LICENSE file.

The samples included in this repository are owned by their respective owners. Please refer to the individual sample files for their specific licensing information.

VST® is a trademark of Steinberg Media Technologies GmbH, registered in Europe and other countries. Other company names, product names and logos are the trademarks or registered trademarks of their respective owners.