Quickstart

Connect a game to MusterBox end to end — register the game, install the SDK, open a session, and report a result.

This guide connects a game to MusterBox end to end: register the game, install the SDK, open a session, and report a result. It takes about ten minutes.

Prerequisites

• A MusterBox account
• A game registered in the MusterBox console
• An SDK package for your engine — Installing the SDK

1. Register your game and create a game key

   Register the game in the MusterBox console. The console issues a game key (x-game-key) scoped to a game and environment. The game key is public by design: it is bound to the allowed origins of the hosted game.

   The game key is intended for browser-hosted games. Keep it out of mobile app binaries, where it cannot be origin-locked.

   Game key .......... gk_8f21c3a9...
   Environment ....... sandbox
   Allowed origins ... https://play.musterbox.org
   Scopes ............ session (required to open matches)
   
2. Install the SDK

   Web (sdk-js + WebAssembly)

   # From the packaged tarball (see engines/web)
   npm install @musterbox/sdk-js @musterbox/sdk-wasm
   
3. Initialize and authenticate

   Browser

   import { createMusterBox } from "@musterbox/sdk-js";
   
   const box = createMusterBox({
     gameId: "my-arena-game",
     gameKey: "gk_8f21c3a9...",
     environment: "sandbox",
   });
   
   box.addEventListener("ready", async () => {
     await box.authenticate({
       identifier: "[e-mail]",
       password: "********",
     });
     console.log("authenticated:", box.getStatus());
   });
   
4. Open a match session

   Use a real matchId from the tournament you entered:

   Browser

   const session = await box.openSession({
     environment: "sandbox",
     matchId: 1042,
   });
   const { sessionId, token, expiresAt, context } = session;
   // context: { tournamentId, matchId, participantId, slot }
   
5. Submit the result

   Report the final outcome. It is accepted only after a session-token-validated claim from both players.

   Browser

   const decision = await box.submitResult({
     environment: "sandbox",
     matchId: 1042,
     outcome: "PLAYER_A_WIN", // PLAYER_A_WIN | PLAYER_B_WIN | DRAW
   });
   // decision: { decision, matchId, reason, claimCount }
   
6. Shut down cleanly

   Browser

   box.logout().finally(() => box.destroy());
   

You’re connected

Next: read the production checklist before shipping, or go straight to the SDK reference.