Skip to main content

Plugin Map Overview

Plugin map files are used by KnobConnector to organize and display your plugin's parameters in a hierarchical structure with additional details. These maps are stored in the Reaper user directory (Options -> Show REAPER resource path in explorer/finder) under Data/KnobConnector/plugin_maps and are written in TOML format. You can create a separate map for each plugin or store multiple plugin maps in a single file if needed.

Here’s a simple example of how a plugin map might look:

[plugin]
name = 'ReaComp'

[[plugin.module]]
name = 'Main'

[[plugin.module.submodule]]
name = 'Compression'

[[plugin.module.submodule.parameter]]
index = 0
name = 'Threshold'

[[plugin.module.submodule.parameter]]
index = 1
name = 'Ratio'

[[plugin.module.submodule.parameter]]
index = 2
name = 'Attack'

[[plugin.module.submodule.parameter]]
index = 3
name = 'Release'
unusedIf = "p16>0.5"

[[plugin.module.submodule.parameter]]
index = 16
name = 'Auto Release'
valueTexts = ["Off", "On"]

[[plugin.module.submodule]]
name = 'Details'

[[plugin.module.submodule.parameter]]
index = 4
name = 'Pre-comp'

[[plugin.module.submodule.parameter]]
index = 14
name = 'Knee'

For more complex examples, check out some of the provided plugin maps and refer to the following properties sections.