SWU Simulator SDKTypeScript client for the simulator engine

Namespaced HTTP resources, ergonomic match sessions, and generated protocol types from the Rust server contract.

Resource API

Use client.system, client.cards, client.matches, client.session, and client.limitedEvents for all HTTP and socket workflows.

Opt-in runtime validation

Ships lean by default. Pass createSchemaValidator() to check requests, responses, and socket frames against the generated JSON schemas.

Match sessions

MatchSession tracks seat, snapshots, events, errors, reconnects, waits, pings, and explicit cleanup for one seat.

Multiplayer matches

Create Twin Suns matches for 2-4 players, join each seat, and drive one private socket per player token.

Runtime adapters

No bundled WebSocket dependency. Browser runtimes work directly; Node consumers inject a socket factory.

Quick Start

bash

pnpm add @my-swu/simulator-client

import { createSimulatorClient
 } from '@my-swu/simulator-client'

const simulatorClient
 = createSimulatorClient
({
  baseUrl
: 'http://127.0.0.1:4000',
})

// Use card ids; see /guide/card-ids for what each number means.
const premierHostDeck
 = {
  leader
: 46102, // Leia Organa - Someone Who Loves You
  leaders
: [], // Twin Suns only; Premier uses the single `leader` above.
  base
: 308, // Echo Base
  cards
: Array
.from
({ length
: 50 }, () => 45), // Alliance X-Wing
  sideboard
: [],
}

const hostAccess
 = await simulatorClient
.matches
.create
({
  // Fixed seed keeps this quick start reproducible.
  seed
: '7',
  format
: 'premier',
  playerCount
: 2,
  hostDeck
: premierHostDeck
,
  hostName
: 'Host',
  hostAuthenticated
: false,
  historyIdentities
: [],
  aiOpponents
: [],
})

// Session state keeps private access out of renderable state.
const matchSession
 = simulatorClient
.session
.create
(hostAccess
)
await matchSession
.connect
()

matchSession
.on
('snapshot', matchSnapshot
 => {
  // Snapshots are the UI source of truth.
  console
.log
('prompt:', matchSnapshot
.prompt
)
})

matchSession
.ready
()

Next steps: