How to Install DesignBuilder Plugins

Modified on Fri, 4 Apr at 11:08 AM

DesignBuilder plugins typically consist of a single dll file, but more complex plugins may also include other support files. The file(s) should be placed in the defined User Plugins folder on the disk where DesignBuilder can find them. This article explains how to do that.

Follow these steps:

1A. Click on the DesignBuilder File > Folders > Library data folder menu option. In Windows File Explorer go up one level to the DesignBuilder folder and you should find the User Plugins folder listed there.

1B. Alternatively, you can navigate to your local application data folder using Windows File Explorer.

Usually, this can be found at C:\Users\<username>\AppData\Local\DesignBuilder\User Plugins, where “<username>” is your user name.

Note: The AppData directory may be hidden in which case you’ll have to enable the display of hidden files, folders, and drives in Windows File Explorer.

To do that click on the "View > Show > Hidden items" menu option.

2. Navigate to the "User Plugins" folder. If there is no folder called “User Plugins”, create one.

3. Create a new sub-folder under "User Plugins" using any name that describes the plugin. The name you choose does not matter.

4. Copy the plugin dll plus and any external assemblies or other support files that your plugin relies on to the sub-folder you created. E.g. EPNet.dll might also need to be copied to the folder if the plugin uses it.

Note: Each plugin dll (and any support files required) should be placed into its own sub-folder under the “DesignBuilder\User Plugins” folder (the name of the sub-folder does not matter).

5. The first time you start DesignBuilder after installing the plugin you will be asked to confirm that the plugin is from a trusted source:

If you trust the plugin, click on "Yes" to allow DesignBuilder to access it. Your response will be stored and you won't be asked again.

6. If in the future you need to uninstall the plugin, simply close DesignBuilder and delete the relevant sub-folder under the “DesignBuilder\User Plugins”.