From 570e1a845f7b1ba3ecb14e23f183040293a9747b Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 16 Nov 2026 23:42:33 -0500 Subject: [PATCH] ENGINE_API.md: document derivation, starter decks and keyword ids merged in #27 Co-Authored-By: Claude Opus 5.5 --- docs/game/ENGINE_API.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/game/ENGINE_API.md b/docs/game/ENGINE_API.md index e4aedd7..19325b3 100644 --- a/docs/game/ENGINE_API.md +++ b/docs/game/ENGINE_API.md @@ -47,8 +47,9 @@ const r = result(state); // { winner: 0 | 1 | null, reason, topicsLed, lanePow | `scoringPower(state, lane)` | Lane power plus revealed "at scoring" Portals (§7). `result().lanePower` uses this. | | `laneCapacity(state, lane)` | Per-seat capacity of a lane. A Portal such as Stub may override it. | | `isOnTopic(state, cardInPlay)` | §1.4/§6 on-topic test, including Disambiguation. | -| `starterDeck(seed): GameCard[]` | A 12-card loaner deck (DESIGN §2). **Placeholder** cards until starter-cards.json lands. | -| `previewPool(): GameCard[]` | Every loaner card once. For draft modes. | +| `STARTER_DECKS`, `starterDeckById(id, rules?)` | The 4 DESIGN §2.1 starter decks (`stargazers`, `field-guide`, `headliners`, `pioneers`), derived through `deriveCard` with the given rules (a `Ruleset` works). **Use these for new players.** | +| `starterDeck(seed)`, `previewPool()` | Older placeholder loaners (seeded 12-card deck / every placeholder once). Kept for tests and draft prototypes; `previewPool()` moves to `starter-cards.json` in a follow-up. | +| `deriveCard(input, table, rules?)`, `deriveDeck(inputs, table, rules?)` | DESIGN §1 + §10.1: `CardInput` → `GameCard`. **Hosts only**: run on host-frozen, plausibility-checked inputs, never on client JSON. A `Ruleset` can be passed as `rules`. | | `placeCard(state, seat, lane, card)`, `revealPortal(state, lane)` | Test helpers for building boards by hand. | ## 2. Actions @@ -105,6 +106,9 @@ interface GameCard { - **The engine takes already-derived cards and never reads raw stats.** The council asked for this, because snapshot stats are self-reported (#1, critic brief A.1). - Derivation (DESIGN §1 and §10.1: percentile → fame → cost → power, home, trend, keyword and vanillaBonus) lives in `shared/game/derive.ts`, which engine-b owns. Hosts run it on host-frozen, plausibility-checked inputs before calling `createMatch`. +- `CardInput = { cardId, pageId | null, title, category, rarity, snapshot: { stats }, live: { trendPercent, dailyAverage }, check, pinned? }`. `pinned: { cost, home, faction }` replaces §1.1–1.5 **only** when `check === 'loaner'`. `check === 'unchecked'` caps cost at `uncheckedCostCap` (home and fame are kept). +- **Never build `GameCard`s from client JSON.** `validateDeck` only checks shapes and ranges; a client could send cost 1 / power 30. Constructed modes must re-derive on the host. +- Both seats can hold the same loaner `cardId`. The engine keys per seat, so UIs should key cards by `owner + cardId`. - Modes may adjust `GameCard` fields such as `power` before `createMatch`. The engine does not re-derive them. - A keyword that isn't in `ruleset.keywordsEnabled` never runs. Derivation is responsible for not giving that card `vanillaBonus`. - Lane power = `power` + `bonus` + `trend` + `onTopicBonus[cost]` if on-topic + ongoing keyword and Portal effects, floored at 0. @@ -191,7 +195,7 @@ Scoring runs after the last turn's End phase. Lane powers include revealed "at s ## 8. Keywords and Portals (extension contract) -`KEYWORDS` and `PORTALS` in `shared/game/keywords.ts` (engine-b) are registries of hook objects. The header of that file is normative. Every hook gets `ctx = { state, rng, params, lane, log, power(card) }`. +`KEYWORDS` and `PORTALS` in `shared/game/keywords.ts` (engine-b) are registries of hook objects. v1 keywords (`V1_KEYWORDS`, one per faction via `FACTION_KEYWORD`): viral, rising, local, encyclopedic, nostalgic, translated; optional (`OPTIONAL_KEYWORDS`, off by default): edition, obscure, wildcard. Portals: the 6 kinds of §10.3. The header of that file is normative. Every hook gets `ctx = { state, rng, params, lane, log, power(card) }`. **Keywords** - `onReveal(ctx, self)` and `endOfTurn(ctx, self)` may change `bonus` on cards in `ctx.state`. @@ -220,4 +224,4 @@ Portal hooks act only once the Portal is revealed. - on-topic power, the consensus tie-break, and Portal capacity, fizzle and at-scoring hooks - disabled keywords, AFK and concede, and draws - the random-play property: matches terminate, replay exactly, and serialise after every action -- `tests/game-*.test.ts` (engine-b): keywords, card derivation, property tests and the DESIGN §12 golden match. +- `tests/game-keywords`, `game-derive`, `game-starter`, `game-property`, `game-golden` (engine-b): every keyword and Portal, derivation, starter decks, properties (termination, determinism, round-trip, no input mutation, legality, power ≥ 0, capacity, no hand leak) and the DESIGN §12 golden match (19–15 / 15–19 / 13–10, p0 wins).