Skip to content

Sample plugins

Besides the plugins that come with the app, sample plugins in forgeplane/pinrail-plugins show what else a plugin can do. They are not installed with Pinrail. Install the ones you need, as described below.

PluginTitleWhat it is for
artifactHTML artifactAn HTML page an agent designed, commented on element by element, with selectors sent back to the agent.
audioAudio reviewAudio takes, such as voices reading one script, compared with their waveforms and transcripts, commented at a moment, and cut.
calendarCalendarTimes to arrange around what is already booked: one suggested slot picked per item, another time asked for, or the item declined.
canvasDesign canvasA set of designs on a canvas, such as the steps of a flow or variants of a screen, commented on and approved frame by frame.
emailDraft emailsDrafts an agent wants to send, edited with the changes showing, then sent, revised or discarded one by one.
logoLogo reviewCandidate logo marks seen where they will live, a favourite picked, and changes asked for on parts of a mark.
model-3d3D model reviewCandidate 3D models on a stage to orbit, a favourite picked, and changes asked for on parts of a model.
motionMotion reviewCandidate animations, in CSS or Lottie, played frame by frame and side by side, with a favourite picked.
palettePalette reviewColour palettes or design tokens, painted on a sample screen in light and dark, with their contrast measured.
tradeTrade approvalA trade an agent proposes, on its candlestick chart with the entry, stop and targets to adjust, approved or rejected.
videoVideo reviewA video, such as a promo cut or a screen recording, commented at a moment or over a stretch, on its picture or its sound.
visual-diffBefore and afterThe images of a revision, compared with a wipe, side by side, a fade or a difference highlight, each request marked fixed or not.

Each plugin’s README shows the plugin in use and describes what an agent sends and what comes back.

Each release of a plugin is a zip on the repository’s releases page, named after the plugin and its version, such as email-1.0.0.zip. Download the zip, then install it in Settings › Plugins with Zip…, or from the command line:

Terminal window
pinrail plugins install ~/Downloads/email-1.0.0.zip

You can also install a plugin from a checkout of the repository. The plugins are in its plugins/ folder. artifact, model-3d and motion bundle libraries into their views, so build those first:

Terminal window
git clone https://github.com/forgeplane/pinrail-plugins.git
cd pinrail-plugins
pinrail plugins install ./plugins/email
(cd plugins/model-3d && npm ci && npm run build)
pinrail plugins install ./plugins/model-3d

Installing plugins describes what an install does, and how to upgrade a plugin or replace one.