mark-wiemer / mcbe-polished-quartz

Getting started with Minecraft Bedrock add-on development using the Typescript Beta APIs

Polished Quartz

Polished Quartz is a template project for creating new Minecraft: Bedrock Edition add-ons. It currently supports Minecraft 1.20.30+, and will likely need some changes to support 1.21+.

Installation

1. Install the prerequisites
2. Copy this folder
3. Open a terminal and navigate to this folder
4. Run npm i
5. Follow chapter 2 of the official guide:
   1. Run Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass in PowerShell
   2. Run npm run build
   3. Open Minecraft (Bedrock Edition, not Java Edition)
   4. Add the new "Polished Quartz" behavior pack to a superflat world!

When you load the world, you should teleport to a cobblestone box and be asked to break the terracotta!

Features

Automated tests with vitest. Note since we don't have the Minecraft source code, we must be creative with our imports. We're copying the imports that we need for utility functions into a local file and converting them to interfaces. This way, Vitest doesn't worry about missing implementation details.

References

• Build a gameplay experience with TypeScript - Microsoft Learn
• Minecraft: Bedrock Edition projects: My personal homepage for what I learn about add-on development.