Minecraft: Bedrock Edition Network Protocol Documentation

This repository publishes the packet, type, and enum schemas for the Minecraft: Bedrock Edition network protocol. The protocol can change between releases.

Browse the generated documentation at mojang.github.io/bedrock-protocol-docs.

• json/ contains the protocol schemas. The website is assembled from the metadata found in the repository's GitHub Releases and not from source in main.
• additional_docs/ contains the source Markdown and assets for the guides section.
• legacy_changelogs/ contains changelogs that predate the generated release history.
• scripts/ prepares release metadata and generates the data and pages consumed by the site.
• tools/protocol-docs-generator/ contains the Astro application that renders the documentation.

Use Node.js 24 or newer and npm 11 or newer. From the repository root:

npm ci
npm run dev

The preparation step calls the GitHub API and downloads release archives. Set GITHUB_TOKEN when necessary to authenticate those requests or avoid the unauthenticated API rate limit.

Other useful commands are:

npm run check
npm run build

The Pages workflow runs for pushes to main, version tags matching v*, release changes, and manual dispatches.