create-mvmnt-plugin

This generator creates the manifest, TypeScript setup, development scripts, and first scene element for an external MVMNT plugin. Read the Plugin SDK guide for the authoring model and learning path.

Create an external SDK 2 MVMNT plugin project:

npm create mvmnt-plugin@latest

The interactive setup walks through the plugin ID, plugin directory, element type, element display name, and a keyboard-selectable list of starter templates with a short explanation of each one. An element type is the kebab-case identifier used in source and manifest files, such as my-plugin-element; its suggested display name would be My Plugin Element. For scripts and other non-interactive use, pass the choices as options:

npm create mvmnt-plugin@latest -- --name com.example.pulse --template minimal

Use --template midi-spring for a deterministic, fixed-step simulation example. Keep the default minimal template for ordinary random-access elements.

The first element type defaults to the final plugin-ID segment. Use --element <type> to override it, --plugin-name, --element-name, and --description to customize generated display text, or --dir <path> to choose the output location.

Add another element

Run the same tool from an existing generated plugin. The generator detects the nearest plugin.json and offers to add another scene element, even when run from a nested directory:

cd pulse
npm create mvmnt-plugin@latest

You can also select the add flow explicitly or provide everything non-interactively:

cd pulse
npm create mvmnt-plugin@latest -- add spectrum --template audio-reactive
npm create mvmnt-plugin@latest -- --element spectrum --template audio-reactive

The add flow asks for the element type first, then suggests a title-cased element name before asking for the starter template. The add command reads the plugin identity from plugin.json, creates src/spectrum.ts, and adds the matching entry and capability declaration to the manifest. Target another plugin directory with --dir <path>, and customize the element with --element-name or --description.

The generator refuses duplicate element types and existing element files or template assets. It only adds elements to SDK 2 plugins.

Run npm create mvmnt-plugin@latest -- --help for the complete option list.