The fastest way to start a Minecraft Bedrock addon. Three sources, one command, zero boilerplate.
- 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.mcaddonpackaging. - 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.
npx create-mc-bedrockYou'll be asked for:
- Source — pick one of three:
- Custom Workspace (recommended) — bundled, ships with the
bedrock-buildcompiler (hot reload, deploy,.mcaddonpack). - Microsoft Official Samples — cloned from
microsoft/minecraft-scripting-samples. - Community Templates — cloned from
Keyyard/custom-mc-scripting-templates.
- Custom Workspace (recommended) — bundled, ships with the
- Project name — used for
bedrock.config.json,package.json, and manifest headers. - Destination folder — defaults to
./<project-name>. - (After scaffold) Install dependencies now? —
yto runnpm install,nto skip.
Manifest UUIDs are regenerated for every scaffold and BP↔RP dependency UUIDs are kept consistent.
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 onlySee the full bedrock.config.json reference for compiler options.
- Node.js 18 or higher.
- Windows for
deployretail (custom deploy paths work everywhere). Mac/Linux retail deploy is on the roadmap.
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.
- Beyond64 (OsmaanGani) — package banner artist
- PottedPropagule (PottedPropagule) — issue reporter and helpful feedback
⭐ Star us on GitHub
