Skip to content

Keyyard/create-mc-bedrock-cli

Repository files navigation

Create MC Bedrock CLI

GitHub Stars

Node.js License Discord Website


Create MC Bedrock CLI Banner

The fastest way to start a Minecraft Bedrock addon. Three sources, one command, zero boilerplate.


What's new in 2.0

  • Three sources — Custom Workspace (recommended), Microsoft Official Samples, Community Templates.
  • Bundled Custom Workspace powered by @keyyard/bedrock-build — TypeScript bundling, hot-reload deploy to local Minecraft, one-shot .mcaddon packaging.
  • Pinned dependencies — the scaffolder queries the npm registry and writes resolved versions into your package.json, so every new project starts on current-stable @minecraft/server.
  • Auto-install prompt after scaffold.

Quick start

npx create-mc-bedrock

You'll be asked for:

  1. Source — pick one of three:
  2. Project name — used for bedrock.config.json, package.json, and manifest headers.
  3. Destination folder — defaults to ./<project-name>.
  4. (After scaffold) Install dependencies now?y to run npm install, n to skip.

Manifest UUIDs are regenerated for every scaffold and BP↔RP dependency UUIDs are kept consistent.

Custom Workspace at a glance

my-addon/
  bedrock.config.json
  package.json
  tsconfig.json
  src/
    main.ts                ← entry — bundled into BP/scripts/main.js
  packs/
    BP/  manifest.json + behavior pack files
    RP/  manifest.json + resource pack files
  dist/                    ← build output (gitignored)

Useful scripts the scaffolder writes for you:

npm run build           # dev build
npm run watch           # rebuild on save
npm run deploy          # build + copy to local Minecraft
npm run deploy:watch    # hot reload to local Minecraft
npm run pack            # release build + zip into .mcaddon
npm run release         # release build only

See the full bedrock.config.json reference for compiler options.

Requirements

  • Node.js 18 or higher.
  • Windows for deploy retail (custom deploy paths work everywhere). Mac/Linux retail deploy is on the roadmap.

Contributing

Want to add a Community Template? Open a PR against Keyyard/custom-mc-scripting-templates.

Found a bug in the scaffolder or compiler? File an issue here or join the Discord.

Credits

⭐ Stargazers Over Time

Star History Chart
Made for the Minecraft Bedrock dev community.
⭐ Star us on GitHub

About

create-mc-bedrock (bedrockCLI) is a simple and interactive CLI tool to help you quickly set up Minecraft Bedrock workspaces with @keyyard/bedrock-build

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors