SWU Simulator SDKTypeScript client for the simulator engine

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

Get Started

Client API

API Reference

Resource API

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

Runtime validation

Requests, HTTP responses, and socket frames are checked against generated JSON schemas before entering app state.

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
  base
: 308, // Echo Base
  cards
: Array
.from
({ length
: 50 }, () => 45), // Alliance X-Wing
}

const hostAccess
 = await simulatorClient
.matches
.create
({
  // Fixed seed keeps this quick start reproducible.
  seed
: 7,
  format
: 'premier',
  hostDeck
: premierHostDeck
,
})

// 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: