docs: add docs for game

Author: Zamiell

.gitignore

@@ -51,6 +51,9 @@ GitHub_private_key.pem
 # Scripts can create temporary SQL files
 /scripts/bash/*.sql
 
+# Docs for npm packages
+/packages/game/docs
+
 # ------------------------------
 # GitHub Node.gitignore template
 # https://raw.githubusercontent.com/github/gitignore/master/Node.gitignore

.vscode/settings.json

@@ -36,6 +36,7 @@
     "**/misc/keldon/": true,
     "**/server-old/": true,
     "**/card-images/": true,
+    "**/packages/game/docs/**/*.html": true,
     // @template-customization-end
   },
 

package.json

@@ -85,6 +85,7 @@
     "tsconfig": "^7.0.0",
     "tslib": "^2.6.2",
     "tsx": "^4.6.2",
+    "typedoc": "^0.25.4",
     "typescript": "^5.3.3",
     "ws": "^8.15.1",
     "xmlserializer": "^0.6.1",

packages/client/src/game/reducers/stateReducer.test.ts

@@ -1,5 +1,5 @@
 import { draw, replayEnter } from "../../../test/testActions";
-import { testMetadata } from "../../../test/testMetadata";
+import { getTestMetadata } from "../../../test/testMetadata";
 import { initialState } from "./initialStates/initialState";
 import { stateReducer } from "./stateReducer";
 
@@ -8,7 +8,7 @@ jest.mock("./uiReducer", () => ({
 }));
 
 const numPlayers = 3;
-const defaultMetadata = testMetadata(numPlayers);
+const defaultMetadata = getTestMetadata(numPlayers);
 
 describe("stateReducer", () => {
   test("does not mutate state", () => {

packages/client/test/loadGameJSON.ts

@@ -31,7 +31,7 @@ import { ActionType } from "../src/game/types/ActionType";
 import type { CardIdentity } from "../src/game/types/CardIdentity";
 import type { State } from "../src/game/types/State";
 import type testGame from "../test_data/up_or_down.json";
-import { testMetadata } from "./testMetadata";
+import { getTestMetadata } from "./testMetadata";
 
 type JSONGame = typeof testGame;
 
@@ -56,7 +56,7 @@ export function loadGameJSON(gameJSON: JSONGame): State {
   }
   const numPlayers = potentialNumPlayers as NumPlayers;
 
-  const metadata = testMetadata(numPlayers, gameJSON.options.variant);
+  const metadata = getTestMetadata(numPlayers, gameJSON.options.variant);
   const variant = getVariant(metadata.options.variantName);
 
   const cardsPerHand = getCardsPerHand(metadata.options);

packages/client/test/testMetadata.ts

@@ -12,7 +12,7 @@ import {
 import type { Tuple } from "isaacscript-common-ts";
 import { newArray } from "isaacscript-common-ts";
 
-export function testMetadata(
+export function getTestMetadata(
   numPlayers: NumPlayers,
   variantName: string = DEFAULT_VARIANT_NAME,
 ): GameMetadata {

packages/game/README.md

@@ -1,11 +1,15 @@
-# @hanabi/game
+# Hanab Live Game Logic
 
-This contains the rules for the game. Can compute the next game state, given an existing game state and a game action.
+This package contains the rules for the game. These are exported as functions like `isCardTouchedByClue`, `isCardOnChop`, and so on. You can see the full list of functions on the [auto-generated documentation](./docs/modules.html).
+
+Additionally, it can compute the next game state, given an existing game state and a game action (via the `gameReducer` function).
 
 ## Installation
 
+If you want to use the game logic in a bot or some other Hanab-related program, then you can install it from npm:
+
 ```sh
-npm install @hanabi/game --save
+npm install @hanabi-live/game --save
 ```
 
 ## Usage

packages/game/package.json

@@ -24,7 +24,7 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc",
+    "build": "rm -rf dist && tsc --project ./tsconfig.npm.json && npx typedoc ./src/index.ts",
     "lint": "bash ./lint.sh"
   },
   "peerDependencies": {

packages/game/src/reducers/cardPossibilitiesReducer.test.ts

@@ -1,5 +1,5 @@
 import { assertDefined } from "isaacscript-common-ts";
-import { testMetadata } from "../../../client/test/testMetadata";
+import { getTestMetadata } from "../../../client/test/testMetadata";
 import { getVariant } from "../gameData";
 import type { CardState } from "../interfaces/CardState";
 import type { CardOrder } from "../types/CardOrder";
@@ -11,7 +11,7 @@ import { cardPossibilitiesReducer } from "./cardPossibilitiesReducer";
 import { getInitialCardState } from "./initialStates/initialCardState";
 
 const NUM_PLAYERS = 3;
-const DEFAULT_METADATA = testMetadata(NUM_PLAYERS);
+const DEFAULT_METADATA = getTestMetadata(NUM_PLAYERS);
 const VARIANT = getVariant(DEFAULT_METADATA.options.variantName);
 const DEFAULT_CARD = getInitialCardState(0 as CardOrder, VARIANT, NUM_PLAYERS);
 
@@ -93,7 +93,7 @@ describe("cardPossibilitiesReducer", () => {
   });
 
   test("removes possibilities based on previous rank and color clues", () => {
-    const metadata = testMetadata(
+    const metadata = getTestMetadata(
       NUM_PLAYERS,
       "Rainbow-Ones & Brown (6 Suits)",
     );

packages/game/src/reducers/cardsReducer.test.ts

@@ -10,7 +10,7 @@ import {
   play,
   rankClue,
 } from "../../../client/test/testActions";
-import { testMetadata } from "../../../client/test/testMetadata";
+import { getTestMetadata } from "../../../client/test/testMetadata";
 import { getVariant } from "../gameData";
 import type { CardState } from "../interfaces/CardState";
 import type { GameState } from "../interfaces/GameState";
@@ -24,8 +24,8 @@ import { getInitialCardState } from "./initialStates/initialCardState";
 import { getInitialGameState } from "./initialStates/initialGameState";
 
 const NUM_PLAYERS = 3;
-const DEFAULT_METADATA = testMetadata(NUM_PLAYERS);
-const THROW_IT_IN_A_HOLE_METADATA = testMetadata(
+const DEFAULT_METADATA = getTestMetadata(NUM_PLAYERS);
+const THROW_IT_IN_A_HOLE_METADATA = getTestMetadata(
   NUM_PLAYERS,
   "Throw It in a Hole (4 Suits)",
 );