Skip to content

Paul-Dempsey/GenericBlank

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generic Blank

Repo

Generic Blank is a template for a VCV Rack blank panel plugin. This plugin contains only a blank panel module.

It looks like this, in the default light panel, and when the Rack "Prefer dark panels" setting is enabled:

Preview of the Generic Blank module (light) Preview of the Generic Blank module (dark)

This module doesn't demonstrate much more than getting a plugin up and running. It doesn't provide any inputs, outputs, presets, extenders, or do any Digital Signal Processing (DSP). Some of the basic framework you'll need for a more functional module are present as comments. If you want something more than just a blank plugin, then you can follow the Rack plugin development guide or clone any existing module that is open source. Fundamental is a good place to start.

Release notes

NOTE

This template is provided AS-IS. Terms are in the LICENSE file. I built and ran this on Windows 11 and Rack 2.4. If there are issues, please open an issue in this repo. You are responsible for any plugin you make based on this template. If you need more help with building and coding a Rack plugin, VCV Community - Development or the VCV Rack Discord are friendly places to go.

Before you can build this plugin, you must set up a Rack development environment following the guide at VCV Rack Plugin Development.

You can make a new repo for yourself using this repo as a template (click the Use this template button and choose Create a new repository), or you can download as a zip and copy all the files to a folder in your Rack development plugins folder.

To make it your own:

  1. Edit plugin.json to fill in the particulars of your plugin slug and name, module slug and name, your brand and company info, the kind of license you want to use, and so on. See Plugin Manifest for the VCV Rack requirements. These details MUST be different than what appears in this repo.

  2. If you change the plugin slug in plugin.json, you must change the "blank" string in this line in src/Blank.cpp to match:

    Model *modelBlank = createModel<BlankModule, BlankModuleWidget>("blank");

    Now you're ready to build your plugin, run rack and see if it's working. If all is well, you can take the final step.

  3. Edit res/Blank.svg and res/Blank-dark.svg to give your blank module it's unique appearance. It's worthwhile reviewing the VCV Rack Panel Guide for guidance on the design of the panel.

If you want to publish your module to the library, see the information at the end of the Plugin Tutorial.

I hope this is useful to you. If you have questions or a suggestion, you can open an issue or dicsussion in Github, or post to the VCV Rack forum.

:- Paul Dempsey (aka pachde)