Plugin bundle

A .sketchplugin is a folder containing a manifest, scripts and additional resources, such as images, in a specific file layout. It’s a macOS package, arranged as a macOS bundle.

Finder in macOS displays a Sketch plugin as a single file. To browse the bundle contents, select Show Package Contents from the context menu of the plugin bundle.

You can organise your plugin bundle manually or use skpm to generate it as part of the build process.

Folder structure

select-shapes.sketchplugin
  Contents/
    Sketch/
      manifest.json
      circles.js
      rectangles.js
      shared.js
    Resources/
      icon.png
Folder Description
Contents Contains the manifest and all JavaScript (.js) and CocoaScript (.cocoascript) files.
Resources Contains all of the plugin’s resource files.

Plugin Manifest file

For Sketch to initialize the plugin correctly, the manifest.json must be included in the plugin bundle. It defines how the scripts can be called from either the menu or a keyboard shortcut, or triggered by user activity within Sketch. For more information, see the manifest documentation.

See something wrong or incomplete? Improve this page.