create-mcbe
v0.1.0-beta.1
Published
A small, extensible scaffolder for Minecraft Bedrock Edition projects.
Maintainers
Readme
create-mcbe
An extensible Minecraft Bedrock project scaffold generator for both interactive users and coding agents.
One-command setup for agents
Create an SAPI-Pro behavior-pack project, install its npm dependencies, install BePack locally, and resolve Script API dependencies:
npm create mcbe@latest my-addon -- --template sapi-pro --yes --installThen build the project:
cd my-addon && npm run buildTo use a globally installed BePack instead of installing it in the project:
npm create mcbe@latest my-addon -- --template sapi-pro --skip-bepack-install --yesThen run:
cd my-addon && bepack install && npm run buildUse --json when an agent needs machine-readable output:
npm create mcbe@latest my-addon -- --template bepack-addon --yes --install --jsonTemplates
| Template | Description |
| --- | --- |
| sapi-pro | SAPI-Pro behavior pack with the built-in sapi-pro BePack plugin |
| bepack-behavior | TypeScript behavior pack managed by BePack |
| bepack-addon | TypeScript behavior pack and resource pack managed by BePack |
| behavior-pack | Data-only behavior pack without scripts or build tools |
| resource-pack | Data-only resource pack without scripts or build tools |
List available templates:
npm create mcbe@latest -- --list-templatesCommon options
--template <id>: Select a template.--yes: Use defaults and disable prompts; recommended for agents.--install: Install project dependencies after creation. For BePack templates, also run the BePack install script.- If a template declares
skills,--installalso installs each source into the generated project withnpx skills add. --skip-skills-install: Do not install skills declared by the template. This only skips skills; npm and BePack installation still run when--installis used.--install-bepack: Install BePack in the generated project.--skip-bepack-install: Do not install BePack locally; use the globalbepackcommand.--pm <npm|pnpm|yarn|bun>: Select the package manager.--git: Initialize a Git repository.--json: Print machine-readable JSON output.--cwd <path>: Set the directory where the project is created.--force: Allow overwriting a non-empty target directory.
Interactive mode
Run without arguments to choose the project name, template, and BePack installation mode interactively:
npm create mcbeDevelopment
Run these commands from the BePack monorepo root:
npm run build:create-mcbe
npm run check:create-mcbe
npm run test:create-mcbeTo add a template, create a directory under templates/ and register its definition in src/templates/index.ts.
Template authors can opt into skills by adding a URL (or URLs) to the template definition:
skills: 'https://github.com/example/agent-skills'
// or: skills: ['https://github.com/example/skills-a', 'https://github.com/example/skills-b']