Setup and build

Standalone plugin projects use @pumpkin-plugins/pumpkin-api for the runtime facade and @pumpkin-plugins/build for the pumpkin-plugins-build command. Their package manifests declare the npm names and dependencies used to order public tool releases. Install them after their functional Release Please releases are available on npm.

After release, add both dependencies:

pnpm add @pumpkin-plugins/pumpkin-api @pumpkin-plugins/build

Declare the plugin entry and output in package.json:

{
  "pumpkinPlugin": {
    "entry": "src/plugin.ts",
    "output": "build/my-plugin.wasm",
    "engine": "static-hermes",
    "wasi": []
  }
}

Run pumpkin-plugins-build --types-only before tsc --noEmit to generate guest declarations from the upstream v0.1 WIT commit pinned by the installed package's wit.lock.json. The first use, and each lockfile change, fetches that commit into the ignored .cache/pumpkin-api-wit/<lock-digest>/ directory; cached pins need no network access. Run pumpkin-plugins-build to bundle and componentize the entry. The build tool prepares Static Hermes and keeps generated WIT, outputs and caches outside installed package files. See Building for cache overrides and host toolchain details.

The external-consumer workflow defines the packed-consumer matrix. Its Node, pnpm and host-tool versions are listed in the Static Hermes Runtime guide. npm, Yarn and Bun creator launch forms are documented, but their install and build flows are not part of that support contract.