V4 Plugin Guide

Overview

Plugins in v4 have the following capabilities, designed to be an extension of the v3 capability set:

• Custom commands
• Custom export formats
• Playback and IDE hooks
• Menu overrides
• Ability to open custom windows with the side api injected
• Full Electron and NodeJS controls

It's probably easiest just to look at an example plugin to get started

Installation

Plugins are hosted on npm, so installing them is as simple as putting your side project in a nodejs project with a package.json and such, and then listing those packages in the project config section. Alternatively, the side project also takes relative and absolute filepaths if you'd prefer one of those instead.

Distribution

Just publish to npm. :) Further, please prefix your plugin with 'side-plugin-' (side-plugin-example-plugin) so that they can be searched by prefix. Also if you write a plugin, feel free to reach out via a github issue or a PR to add your plugin and if it looks okay, I'll add it. Thanks!