Client overview - tableverse-kit

@tableverse-kit/client is the typed connection between your frontend and a running game. It does not render UI and does not run your rules. Use it from plain TypeScript, React, Vue, Svelte, or any other browser framework.

Create one typed client

Import the executor as a type from your engine package:

import { createTableverseClient } from "@tableverse-kit/client";
import type { executor } from "token-race-engine";

type Game = typeof executor;

export const client = createTableverseClient<Game>();

This type parameter derives the game view, command inputs, discovery requests, and events from the executor. You do not maintain separate frontend types. Use the same client locally and after publishing. A top-level local page connects to tvk dev. A game loaded by Tableverse connects to its host.

Client methods

Method	Use it to
`ready()`	Wait for the first state snapshot.
`getStatus()`	Read `connecting`, `ready`, `reconnecting`, `error`, or `closed`.
`getViewerId()`	Read the player ID assigned to this client.
`getView()`	Read the latest viewer-safe state, or `null` before ready.
`getStateVersion()`	Read the latest snapshot version.
`getAvailableCommands()`	Ask which command IDs the viewer may use now.
`discover(request)`	Ask the engine for legal choices for a command.
`execute(command)`	Submit a typed command.
`subscribe(listener)`	React to snapshots and connection-status changes.
`onEvent(listener)`	React to domain and stage events.
`dispose()`	Close the connection and remove listeners.

Submit a command

await client.ready();

const result = await client.execute({
  type: "advance",
  input: { spaces: 2 },
});

if (!result.accepted) {
  showError(result.reason ?? "command_rejected");
}

The client does not accept actorId. The host supplies the authenticated viewer identity. An accepted response means the rules accepted the command. The updated view arrives through the subscription separately.

Continue building

Local sessions

Configure players and setup input for a local preview.

Published games

Use your client after publishing to Tableverse.