Browse Source

Improve plugin development tutorial.

Before, the instructions to add extra lines to enable a module were hidden at the end of the example session. This commits breaks them out into their own section to make them more obvious.

At least two people have missed this in the last month: https://community.vcvrack.com/t/compiled-module-not-showing-up/5169
pull/34/head
Xavier Shay GitHub 5 years ago
parent
commit
bc68e58e32
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
  1. +7
    -5
      PluginDevelopmentTutorial.md

+ 7
- 5
PluginDevelopmentTutorial.md View File

@@ -65,13 +65,15 @@ Added MyModule to plugin.json
Panel found at res/MyModule.svg. Generating source file.
Found 1 params, 1 inputs, 1 outputs, 0 lights, and 0 custom widgets.
Components extracted from res/MyModule.svgSource file generated at src/MyModule.cpp
```

To enable the module, add the following lines:

To enable the module, add
extern Model *modelMyModule;
to plugin.hpp, and add
p->addModel(modelMyModule);
to the init() function in plugin.cpp.
```
extern Model *modelMyModule; // plugin.hpp
p->addModel(modelMyModule); // init() function in plugin.cpp
```

Open `MyModule.svg` with Inkscape, open the Layers panel, and hide the `components` layer to hide component placeholders.

## Implementing the DSP kernel


Loading…
Cancel
Save