> ## Documentation Index
> Fetch the complete documentation index at: https://docs.musterbox.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> How the MusterBox platform, SDK, and public API fit together.

MusterBox is a tournament and matchmaking platform with a secure purchase
layer. The developer platform is the integration surface for games that run
inside MusterBox.

<Frame>
  <img src="https://mintcdn.com/muster-box/l1c75jc9Fe0Bw7Uo/assets/musterbox-mark.png?fit=max&auto=format&n=l1c75jc9Fe0Bw7Uo&q=85&s=6c8cbc674c2ce66206292cf2138be928" alt="MusterBox mark" width="192" height="192" data-path="assets/musterbox-mark.png" />
</Frame>

## The pieces

### MusterBox SDK (native, Rust core)

A single Rust core library that is packaged for every supported engine and
platform. Version **1.0.0**. The SDK provides:

* configuration with profile files and validation,
* session lifecycle: `initialize` → `start` → `authenticate` → submit events,
* background event flushing with offline buffering,
* a realtime event plane with session, wallet, and status events,
* a secure purchase client with environment-integrity pre-flight,
* diagnostics and health reporting.

### Web SDK (`@musterbox/sdk-js` + `@musterbox/sdk-wasm`)

A browser build of the core compiled to WebAssembly. API is camelCase and
mirrors the native surface: `createMusterBox`, `authenticate`, `refreshToken`,
`logout`, `submitEvent`, `tick`, `pollEvents`, `getStatus`, `getDiagnostics`,
and per-instance lifecycle management.

### Public API

The wire contract the SDK drives. See the [API reference](/api/api-overview).

## Environments

The base URL selects the environment:

| Environment  | Base URL                            | Purpose                       |
| ------------ | ----------------------------------- | ----------------------------- |
| `local`      | `http://localhost:8081`             | Local backend for development |
| `sandbox`    | `https://sandbox-api.musterbox.dev` | Pre-production validation     |
| `staging`    | `https://staging-api.musterbox.dev` | Pre-release integration       |
| `production` | `https://api.musterbox.com`         | Live traffic                  |

Credentials (game keys) are scoped to a game **and** an environment, and are
origin-locked where applicable.

## Supported platforms

| Platform      | Adapter package                                                   | Version               |
| ------------- | ----------------------------------------------------------------- | --------------------- |
| Unity         | `musterbox-unity`                                                 | 1.0.0 (Unity 2020.3+) |
| Godot         | `musterbox-godot` (GDExtension)                                   | 1.0.0 (Godot 4.2+)    |
| Unreal Engine | `MusterBox` plugin                                                | 1.0.0 (UE 5.3/5.4)    |
| Bevy          | Rust plugin                                                       | 1.0.0 (Bevy 0.19)     |
| Cocos Creator | TypeScript binding                                                | 1.0.0 (3.8+)          |
| Defold        | Defold library                                                    | 1.0.0 (1.6.5+)        |
| Web           | `@musterbox/sdk-js` / `@musterbox/sdk-ts` / `@musterbox/sdk-wasm` | 1.0.0                 |

## SDK identity

| Field            | Value             |
| ---------------- | ----------------- |
| SDK version      | 1.0.0             |
| C ABI version    | 1.2.0             |
| Protocol version | 1.0               |
| Config schema    | 1                 |
| License          | MIT OR Apache-2.0 |

## Where a game fits

```text theme={"dark"}
 MusterBox backend                    Your game
 ┌───────────────────────┐    ┌────────────────────────────┐
 │ Auth   (user/login)   │◄───┤  mustMusterBox()           │
 │ Game SDK (sessions)   │◄───┤  openSession({matchId})    │
 │ Game SDK (results)    │◄───┤  submitResult(...)         │
 │ Security (purchases)  │◄───┤  PurchaseClient.mint/verify│
 │ Event plane           │◄─ ─┤  submitEvent → pollEvents  │
 └───────────────────────┘    └────────────────────────────┘
        ▲                                ▲
        │         both participants      │
        │         claim the same         │
        └──────  result to finalize  ────┘
```

See [Architecture](/getting-started/architecture) for the full flow.