# bedrock-protocol

> A Node.js library for Minecraft Bedrock Edition protocol. Create clients, servers, and MITM proxies with built-in authentication and encryption. Handles packet serialization, RakNet transport, and Xbox Live auth.

Unofficial Japanese documentation for PrismarineJS/bedrock-protocol (MIT License).

## Guides

- [Getting Started](/guide/getting-started.md): Installation, features overview, and first client/server examples
- [Client](/guide/client.md): createClient options, authentication, event lifecycle, chat, and commands
- [Server](/guide/server.md): createServer, MOTD, spawn sequence, skin/userData, and player management
- [Relay (Proxy)](/guide/relay.md): MITM proxy for intercepting client-server packets with clientbound/serverbound hooks
- [Realms](/guide/realms.md): Connecting to Minecraft Realms using realmId, realmInvite, or pickRealm
- [Ping](/guide/ping.md): Server status query (MOTD, player count, version) via RakNet unconnected ping
- [RakNet Backends](/guide/raknet-comparison.md): Comparison of raknet-native (C++), jsp-raknet (JS), and raknet-node (Rust)
- [Advanced / Low-level API](/guide/advanced.md): delayedInit, ClientStatus, level_chunk bypass, compression algorithm, protodef precompile
- [Ecosystem](/guide/ecosystem.md): bedrock-provider chunks, resource packs, authTitle/DeviceOS, BDS tooling
- [FAQ / Troubleshooting](/guide/faq.md): Windows loopback, JWT not active, Replit setup, Defender false positive

## Examples

- [Client Examples](/guide/examples-client.md): Chat bots, commands, monitoring, auto-reconnect, delayedInit, Realms
- [Server Examples](/guide/examples-server.md): Join handling, broadcasts, forms, admin commands, spawn sequence
- [Relay Examples](/guide/examples-relay.md): Packet rewrite/block, toasts, forms, sound, broadcasts, statistics

## API Reference

- [Exports Overview](/api/index.md): createClient, createServer, ping, Client, Server, Player, Relay, ServerAdvertisement
- [Client Options](/api/client-options.md): Full options table with authTitle defaults, delayedInit, compression settings
- [Server Options](/api/server-options.md): Full options table with compression algorithm/threshold, maxPlayers
- [Events](/api/events.md): All events for Client, Server, Player, and Relay

## Source

- [GitHub Repository](https://github.com/PrismarineJS/bedrock-protocol): Source code, examples, and upstream documentation
- [Protocol Data](https://prismarinejs.github.io/minecraft-data/?v=bedrock_1.21.50&d=protocol): Packet definitions and protocol version mapping