Tutorial: How to create modules for VCV-Rack

Trainings and tips on how to build your own virtual instrument for the VCV Rack platform, written by uriel Deveaud - 2019

---

Introduction

So, you want to create your own instruments or modules to be played in VCV Rack. Welcome on-board !

Before we start talking about computer programming, let´s have a look at the general profile and basic knowledge you may need during the process of creating your plugin. Right now, you have an idea, and i´am sure, the best one ! As a musician, you may have been diving into some sort of code... or not ! Or maybe, as a programmer, you want to learn how to make musical instruments and audio devices ? This tutorials serie is made for you. Lets look at the general context:

Basically, musicians don´t like to loose their time into coding work, but there are exceptions of course. In this case, you want to join the group of musician-developper, and that´s fine. We will progress step by step and go from a basic module to very complexe ones.

If you are very new to audio programming, c++ and SVG design, you can still follow those tutorials, but i suggest you to be very curious and engaged regarding learning the bases or any introductions that you may see on youtube or other forums and facebook pages... ask, search and take notes ;) By entering into module creation, there is 99% chance that you will produce more than one plugin, so, take it seriously, learn by method, stay organized, go step-by-step, respect yourself... and you will see, slowly, your instrument coming alive !, the price is nothing compared to the full satisfaction of creating your dream´s device and turning it on for the very first time :)

Well, let´s have a look at this tutorial´s menu. Each section presents various tasks that you want to repeat as necessary, depending of your personal project. So first, you need to know about the "VCV modules API code structure", to know how to compile a plugin and finally to test your creation "live" in VCV Rack. Once this cycle is understood, you are ready to developpe your module´s features and users interface (UI). As just said, we are progressing, following these 3 steps in loop:

• Looking for code expressions and understanding the "rules"
• Adapting the code rules to the actual needs
• Duplicate and clean code sections

Of course, after some times, you will build your own codes library and you will be able to jump quickly to the next level ! One common suggestion, and it is very important, if you are not an experienced programmer, to "explore" other Module´s codes from their authors pages. From them, you will learn what solution they were choosing and what is the result. You can download their repositories and build them on your local machine. Great teaching, but at least, you need to understand what you are reading :) Let´s reach this objective together with this tutorials serie. Enjoy !

Summary

1. Prerequisites
   • Tutorial 01: Setup your development environment under Win10 > Read the tutorial
     • Install a compiler and text editor
     • Downloading the VCV Rack Repository and building the main application
     • Configuring files and folders

---

2. Building your First complete module
   • Tutorial 02: Build and test the classic VCV Fundamental modules > > Read the tutorial
     • Download the package files
     • Build and test the modules in VCV Rack
   • Tutorial 03: Use the new tutorial´s template > > Read the tutorial
     • Set basic module settings files and folders
     • Build and store new modules
     • Test your module in VCV Rack

---

3. Organizing your work and planning tasks
   • Tutorial 04: Consolidating and validating your project > > Read the tutorial
     • Check for similar existing plugins
     • Draw some mockups and define features
   • Tutorial 05: Are you ready ? if yes, time to work > > Read the tutorial
     • Setting up your SLUG, ModuleName, and files
     • Defining size and style for your module
     • Commenting your code blocks

---

4. Building your first created module
   • Tutorial 06: Building basic components > TODO
     • Objective, creating a simple audio circuit, aka "THE MIXER"
     • Creating Input and outpout ports
     • Creating a knob that controls a num param
     • Creating a switch button to change a boolean param
     • Creating a vu meter to visualize a num param
     • Creating a screen to visualize any param
     • Creating a momentary button
     • Creating a menu with static infos
     • Creating a user´s dynamic info on panel
   • Tutorial 07: Customizing your components > TODO
     • Creating your background layer
     • Creating new controls
     • Creating a screen panel
     • Adding some conditional infos in the menu
     • Adding some folders for presets

---

5. Building an advanced module
   • Tutorial 08: Creating an audio source > TODO
     • Objective, creating a new audio circuit, aka "THE SAMPLER"
     • ...
   • Tutorial 09: Creating a wave generator > TODO
     • Objective, creating a new audio circuit, aka "THE SYNTHETIZER"
     • ...
   • Tutorial 10: Creating a filter section > TODO
     • Objective, creating a new audio circuit, aka "THE EQUALIZER"
     • ...

---

...

• i am looking for people who can help to extend this documentation on building modules on MacOS and Linux ;)