Skip to content

Submission ​

Prepare your plugin for distribution via the marketplace.

Build the package ​

Node plugins use the dotx-plugin CLI (included with @dotmatrixlabs/dotx-plugin-sdk) to create the marketplace zip:

bash
npm run package

This produces dist/<plugin-name>.dotxplugin containing:

  • manifest.json
  • The entry file declared by manifest.main
  • Optional assets/, data/, and bin/ directories (if they exist)
  • Any extra paths listed in manifest.packaging.include

Example manifest.json with extra files:

json
{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "dotxVersion": ">=2.0.0",
  "permissions": ["net"],
  "main": "main.js",
  "packaging": {
    "include": ["locales", "templates/email.html"]
  }
}

Checklist ​

  • All required manifest fields are present and valid (id, name, version, description, author, dotxVersion, permissions, main)
  • version is valid semver (e.g. 1.0.0)
  • dotxVersion is a valid semver range (e.g. >=2.0.0)
  • Tested locally against the latest Dot X version
  • Changelog updated
  • dist/<plugin-name>.dotxplugin builds successfully with npm run package
  • (Optional) GitHub Release workflow set up via release-plugin.yml