@openturn/gamekit

Worker-safe. Compiles to a normal GameDefinition<...> from @openturn/core. Every gamekit game is a core game.

Install

bun add @openturn/gamekit

Authoring

`defineGame(definition)`

export const game = defineGame({
  maxPlayers: 2,                  // pool size — generates IDs "0",..,"N-1"
  // minPlayers: 2,               // optional; defaults to maxPlayers
  // playerIDs: ["white","black"] as const,  // opt-in for named seats
  setup: (context) => ({ /* initial G */ }),
  turn: turn.roundRobin(),
  initialPhase: "play",
  phases: { play: { label: "Take your turn" } },
  computed: { /* derived values */ },
  moves: ({ move, queue }) => ({ /* ... */ }),
  views: { public: ({ G }) => ({ /* ... */ }) },
  core: { /* optional escape hatch to core primitives */ },
});

maxPlayers, playerIDs, and minPlayers work the same as in core’s defineGame — see @openturn/core. Pass exactly one of maxPlayers (default IDs) or playerIDs (named seats); set minPlayers lower than the pool size for variable-player games.

`move(definition)`

Build a move. Supports three forms:

move({ run: ({ G, move }) => move.stay() })
move<PlaceMarkArgs>({ run: (...) => ... })       // typed args
move.withArgs<PlaceMarkArgs>()({ run: (...) => ... })  // currying for generic helpers

A move definition:

interface GamekitMoveDefinition {
  args?: TArgs;
  phases?: readonly TPhase[];
  run: (context) => MoveOutcome;
}

`defineMoves(moves)`

Typing helper for a { [name]: move(...) } record. Optional; inlining the record works too.

`defineProfile(config)`

Gamekit-flavored re-export of core’s defineProfile. Same signature, but defaults the result type to GamekitResultState | null so commit({ result }) gets result.winner typed without a cast. See Profiles below.

`GamekitSetupContext<TPlayers, TProfile>`

The context passed to setup(context). Provides:

interface GamekitSetupContext<TPlayers, TProfile> {
  match: MatchInput<TPlayers>;
  now: number;
  /** Per-player profile snapshot, hydrated with defaults for any seated player who had no stored profile. Empty object when the game declares no profile. */
  profiles: Readonly<PlayerRecord<TPlayers, TProfile>>;
  seed: string;
}

Use the typed match (with match.players) so helpers like roster.record(match, 0) narrow to the declared player IDs. RNG is created from seed by gamekit itself; setup runs before any random draws.

Outcomes (`move.*`)

Helper	Compiles to
`move.stay(patch?, options?)`	same phase, `turn: "preserve"`
`move.endTurn(patch?, options?)`	same phase, `turn: "increment"`
`move.goto(phase, patch?, options?)`	target phase (`options.endTurn?: boolean`)
`move.finish(result, patch?, options?)`	terminal `__gamekit_finished` with the given `result`
`move.invalid(reason?, details?)`	`rejectTransition(reason, details)`

move.finish accepts any JSON-compatible record as the result; the conventional shapes — { winner: playerID } and { draw: true } — are typed for ergonomics, but multi-winner, ranked, scored, and co-op results are all valid:

move.finish({ winner: player.id })
move.finish({ draw: true })
move.finish({ scores: { "0": 12, "1": 7 } })

Every non-invalid outcome accepts a final options bag with { enqueue?, profile? }:

enqueue?: readonly QueuedEvent[] — internal follow-up events to chain.
profile?: ProfileCommitDeltaMap — per-player profile deltas applied atomically with the move. Build them with profile.bind(...).inc/push/set/remove or profile.update(...). Apply failures reject the move. See persistent profiles.

Turn policies

`turn.roundRobin()`

The only built-in turn policy. Assigns currentPlayer as players[(turn - 1) % players.length].

Views

`view.computed(context, ...keys)`

Pluck computed values into a view:

view.computed(context, "submittedCount", "scoreLeader")
// returns { submittedCount, scoreLeader }

`view.merge(base, context, ...keys)`

Spread computed values into an existing object:

view.merge({ board: G.board }, context, "submittedCount")

Modifiers

Helpers for composing modular effects (auras, buffs, item effects) into a final value through a callback-based modifier pipeline. Re-exported under modifiers from ./modifiers.

modifiers.evaluateValue({ base, context, modifiers, stageOrder? }) — fold an ordered list of modifiers over base, returning { value, applied }.
modifiers.evaluateNumber(...) — same as evaluateValue with TValue = number.

const { value, applied } = modifiers.evaluateValue({
  base: 10,
  context: { unit },
  modifiers: [
    { id: "armor", stage: "defense", apply: (current) => current * 0.8 },
    { id: "shield", stage: "defense", priority: 10, apply: (current) => current - 2 },
    { id: "crit", apply: (current, ctx) => ctx.unit.crit ? current * 2 : current },
  ],
  stageOrder: ["offense", "defense"],
});

Modifiers are sorted by stage (using stageOrder plus first-seen order for unknown stages), then priority (higher first), then declaration order. Pass an empty context object ({}) when you do not need a context.

Modifier types

interface Modifier<TValue, TContext = void> {
  id: string;
  apply(current: TValue, context: TContext): TValue;
  priority?: number;
  stage?: string;                            // defaults to "default"
}

interface AppliedModifier {
  id: string;
  index: number;
  priority: number;
  stage: string;
}

interface ModifierEvaluation<TValue> {
  value: TValue;
  applied: readonly AppliedModifier[];
}

interface EvaluateValueOptions<TValue, TContext = void> {
  base: TValue;
  context: TContext;
  modifiers: readonly Modifier<TValue, TContext>[];
  stageOrder?: readonly string[];
}

interface EvaluateNumberOptions<TContext = void>
  extends EvaluateValueOptions<number, TContext> {}

Modifier.id must be non-empty; stageOrder entries must be non-empty and unique (the helper throws otherwise).

Profiles

Gamekit’s defineGame accepts an optional profile field that hydrates match.profiles before setup and runs a pure commit function when the match terminates. The API is re-exported from @openturn/core:

import { defineGame, defineProfile } from "@openturn/gamekit";

const profile = defineProfile<{ wins: number }>({
  schemaVersion: "1",
  default: { wins: 0 },
  commit: ({ result }) => {
    const winner = (result as { winner?: string } | null)?.winner;
    return winner === undefined ? {} : { [winner]: [{ op: "inc", path: ["wins"], value: 1 }] };
  },
});

export const game = defineGame({
  maxPlayers: 2,
  profile,
  setup: () => ({ over: false }),
  moves: ({ move }) => ({
    tap: move({ run: ({ player, move: m }) => m.finish({ winner: player.id }) }),
  }),
});

Gamekit’s result is Record<string, JsonValue | undefined> & { draw?: true; winner?: PlayerID }, so commit can read result.winner (or any custom field your game records). Also re-exported: applyProfileDelta, computeProfileCommit, validateProfileDelta, and the delta grammar types. See concepts: persistent profiles and how-to: persist player state.

Core escape hatch

For the rare case gamekit’s shape does not fit, pass raw core pieces via core:

defineGame({
  maxPlayers: 2,
  setup: () => ({ ... }),
  moves: { ... },
  core: {
    states: { archived: { activePlayers: () => [] } },
    transitions: [/* raw core transitions */],
    selectors: { /* ... */ },
    initial: "archived",
    views: { /* ... */ },
  },
});

Key types

GamekitDefinition<...> — the shape of the input definition.
GamekitMoveDefinition<...> — a single move.
GamekitPhaseConfig<...> — a phase’s configuration (activePlayers, label).
GamekitState<TState> — the internal wrapper type (TState & { __gamekit: GamekitInternalState }). You rarely touch it; it is exposed for typing views in edge cases.
GamekitInternalState — the private compartment gamekit owns inside a game’s G. Exposed at runtime as G.__gamekit. Carries the optional result: GamekitResultState | null plus arbitrary JSON-shaped slots gamekit reserves for future internal state. You should not write to it directly; use move.finish / move.invalid instead.
GamekitResultState — Record<string, JsonValue | undefined> & { draw?: true; winner?: PlayerID }.
GamekitViews<...> — the shape of the optional views field on a GamekitDefinition.
MovePlayerContext, MovePermissionContext, MoveRunContext — the context passed to run (and the slice of it that’s also available on phase resolvers).
MoveOutcome, MoveHelpers — outcome and helper types.
TurnContext, TurnPolicy — turn types.

Authoring

Hosting

UI & tools

@openturn/gamekit

Install

Authoring

`defineGame(definition)`

`move(definition)`

`defineMoves(moves)`

`defineProfile(config)`

`GamekitSetupContext<TPlayers, TProfile>`

Outcomes (`move.*`)

Turn policies

`turn.roundRobin()`

Views

`view.computed(context, ...keys)`

`view.merge(base, context, ...keys)`

Modifiers

Modifier types

Profiles

Core escape hatch

Key types

See also

Authoring

Hosting

UI & tools

Documentation Index

​Install

​Authoring

​defineGame(definition)

​move(definition)

​defineMoves(moves)

​defineProfile(config)

​GamekitSetupContext<TPlayers, TProfile>

​Outcomes (move.*)

​Turn policies

​turn.roundRobin()

​Views

​view.computed(context, ...keys)

​view.merge(base, context, ...keys)

​Modifiers

​Modifier types

​Profiles

​Core escape hatch

​Key types

​See also

Install

Authoring

`defineGame(definition)`

`move(definition)`

`defineMoves(moves)`

`defineProfile(config)`

`GamekitSetupContext<TPlayers, TProfile>`

Outcomes (`move.*`)

Turn policies

`turn.roundRobin()`

Views

`view.computed(context, ...keys)`

`view.merge(base, context, ...keys)`

Modifiers

Modifier types

Profiles

Core escape hatch

Key types

See also