Skip to content

README.md

Latest commit

 

History

History
143 lines (103 loc) · 2.84 KB

README.md

File metadata and controls

143 lines (103 loc) · 2.84 KB

Spawnpack

Spawnpack is a Bun-powered CLI for scaffolding Minecraft Bedrock add-on projects with a guided terminal wizard.

It generates BP/RP structure, optional Script API setup, optional rgl integration, marketplace-ready namespaced content folders, and optional AI tooling files.

Features

  • Inline wizard built with @clack/prompts
  • Behavior Pack and Resource Pack scaffold
  • Scripting options: None, JavaScript, TypeScript
  • Optional packages:
    • @minecraft/server
    • @minecraft/server-ui
    • @minecraft/vanilla-data
    • @minecraft/math
  • Optional rgl setup for faster Bedrock builds
  • Optional marketplace add-on structure using nested namespace/projectId folders in BP/RP content directories
  • Optional Rockide recommendation during setup
  • Optional AI setup:
    • CLAUDE.md
    • .mcp.json

Runtime Requirement

Spawnpack is published on npm, but it runs on Bun.

Install Bun first:

Install

Global install with Bun

bun add -g spawnpack

Global install with npm

npm i -g spawnpack

One-off run with Bun

bunx spawnpack

Run locally

bun install
bun run src/index.ts

Usage

spawnpack

Show the installed version:

spawnpack -v
spawnpack --version

The wizard walks through:

  1. Project name and author
  2. Marketplace add-on structure toggle
  3. Destination folder
  4. Script API setup
  5. Publisher ID and Project ID when needed
  6. Script packages
  7. rgl toggle
  8. Rockide toggle
  9. AI setup toggle
  10. Review screen and generation

Generated project options

Depending on your choices, Spawnpack can generate:

  • packs/BP
  • packs/RP
  • data/scripts/main.ts
  • packs/BP/scripts/<publisher-id>/<project-id>/main.js
  • package.json
  • tsconfig.json
  • dprint.json
  • config.json for rgl
  • CLAUDE.md
  • .mcp.json

Marketplace structure mode

When enabled, Spawnpack creates marketplace-style nested folders under many BP/RP content directories.

Example:

packs/BP/animation_controllers/publisher/sample/
packs/BP/entities/publisher/sample/
packs/RP/animation_controllers/publisher/sample/
packs/RP/textures/items/publisher/sample/

This helps multiple add-ons coexist more safely in the same world by reducing content path collisions.

Script dependency versions

Spawnpack fetches the latest stable npm versions for:

  • @minecraft/server
  • @minecraft/server-ui
  • @minecraft/vanilla-data
  • @minecraft/math

If version lookup fails, it falls back to baked stable defaults.

Development

bun install
bun run typecheck
bun run build

Publish notes

The npm package is configured to publish only:

  • dist/spawnpack.js
  • templates/CLAUDE.md
  • README.md
  • LICENSE
  • package.json

Internal planning files, Serena state, and local AI/project notes are excluded from the published tarball.