Skip to content

V4 Plugin Guide

Jump to bottom
Todd Tarsi edited this page Aug 30, 2023 · 4 revisions

Welcome to the v4 plugin guide! I've tried to optimize plugin authorship in v4 to be pain-free and frankly pretty sweet!

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 better 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 just reference the plugins that way. Alternatively, the side project also takes relative and absolute filepaths if you'd like to do 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!

Clone this wiki locally