Quick Start

Quick start

1. Install the host pack and enable it on the world.
2. Install this client and mcbe-ipc.
3. Use the sample below — it waits for the host, then asks the catalog:

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

const registry = createBedrockClient(5); // timeout in ticks (~5 × 50ms)

const ok = await registry.waitReady();
if (!ok) {
  // Host missing or too slow — do not invent a craft
  return;
}

const yields = await registry.result({
  station: "minecraft:furnace",
  inputs: ["minecraft:beef"],
});
// e.g. [{ outputs: ["minecraft:cooked_beef"], type: "smelt" }]

const ids = await registry.match({
  station: "minecraft:crafting_table",
  pattern: ["A", "A"],
  key: { A: "minecraft:oak_planks" },
});
// e.g. ["minecraft:stick"]

const stickRecipes = await registry.list({
  output: "minecraft:stick",
});
// e.g. [{ id: "minecraft:stick", type: "shaped", stations: ["minecraft:crafting_table"] }, …]

Rules of thumb

• Always call waitReady() before other methods (or handle undefined / empty failures).
• A station is a block id (minecraft:furnace, minecraft:crafting_table, mymod:crusher).
• Vanilla recipes are already in the host. You only register your own — register takes an array of recipes in one call.
• If the host is down, fail closed. Do not guess outputs.

Next: API reference · Asking the catalog