Installation

Installation

Requirements

• Minecraft Bedrock 1.21.100+
• Script API @minecraft/server 2.8.0 (stable; no Beta APIs experiment)
• mcbe-ipc inside your pack. This library handles communication between packs (Dependencies)

A Bedrock Registry host in the world is what holds the catalog. Add a UUID dependencies entry only if your addon cannot function without that catalog. Register-only packs (including the template) do not.

Option A — npm (recommended)

If you bundle your behavior pack (esbuild or similar):

npm install @mcbe-registry/client mcbe-ipc

import { createBedrockClient } from "@mcbe-registry/client/bedrock";

createBedrockClient is the live entry that wires this library to Bedrock’s system and to mcbe-ipc. Ship both packages into the pack’s script. Bedrock does not read node_modules at runtime.

Option B — drop-in script

If you do not use a bundler:

1. Download bedrock-registry-client.js from this client’s GitHub Releases. That file is this library, pre-built as one script.
2. Download the mcbe-ipc pack build from OmniacDev/MCBE-IPC and save it next to the client file, named exactly mcbe-ipc.js.
3. Import from your pack’s entry script:

import { createBedrockClient } from "./bedrock-registry-client.js";

Register only, no query: also download bedrock-registry-register.js from the same Release. See Register template.

Manifest dependency

Add the host to your behavior pack manifest.json dependencies only when the addon cannot run without the catalog. Bedrock will not download the host automatically; the player still has to import Bedrock Registry once.

• uuid: 33303c67-a05d-4964-b2c3-ba7c42d8d3b6 — identifies this host and stays the same across pack versions.
• version: the matching host pack version, as three integers [major, minor, patch].