README.md

Important

We're working on a restructure of the repository, and planning on switching to a different GUI for the plugins. Read more at #477

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	Status
Toybox C1200
Orchestron	WIP
Bells
Hohner Melodica
Mellotron
NoiseG8

Installation

For VST3 plugins, unzip and move the folder ending in .vst3 into the VST3 directory. Normally this is set to 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

You can create a dedicated folder within the VST3 directory, e.g., ZMANN, for better organization.

For CLAP plugins download and move the .clap file into C:\Program Files\Common Files\CLAP. (or the custom folder that you have set up in your DAW)

Table of Contents

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

Demo

Building

Warning

Currently we don't have any plans to support Mac OS, although the plugins should work after compiling to a Mac OS target. Read more about cross-compilation..

Prerequisites

• Rust

Windows

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

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

Building the plugins

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

$ cargo xtask bundle orchestron --release

After successfully building, each plugin will make their own VST3 and CLAP bundle inside of the /target/bundled/ folder.

Alternatively, build all plugins inside of the repository by running:

$ cargo ci

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 ci

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.