@netforge/tabletop 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,55 @@
 # @netforge/tabletop
 
-The client kit the board-style Net Forge templates share (tower defense,
-idle, card battler, monster collector): the room connection and input clock
-for rules genres, the styled 3D stage, the store, stake and gear wiring, and
-the HUD shell. Used by `@netforge/template-*` clients; see
-`@netforge/kit-play` to run one on your own computer.
+The shared client kit for the Net Forge board-style game templates (tower defense, idle, card battler and monster collector): the room connection and input clock for rules genres, the styled 3D stage, the store, stake and gear wiring, and the HUD shell.
+
+## Install
+
+```sh
+npm install @netforge/tabletop
+```
+
+Node 20 or later. The package ships TypeScript source (ES modules) for a bundler such as Vite. It is used by template clients (`@netforge/template-tower`, `template-idle`, `template-cards`, `template-collector`). Game code in `src/game.ts` never imports it.
+
+## Example
+
+A board template's client boots with one call. This is the shape the tower defense client uses:
+
+```ts
+import { bootBoard } from "@netforge/tabletop";
+import { GAME_VERSION, PLACE, TEMPLATE, towerAdapter, towerManifest } from "@netforge/template-tower";
+
+const app = await bootBoard({
+  adapter: towerAdapter(),
+  manifest: towerManifest(),
+  template: TEMPLATE,
+  place: PLACE,
+  version: GAME_VERSION,
+  labels: { title: "COGSPIRE", rules: {}, skus: {}, upgrades: {}, loading: "Winding the spire", help: "Click a tile to build" },
+  theme, // HudTheme: accent, gold, ink, dim, panel, bg, font, display, radius
+  coin: { name: "Cog", symbol: "COG", logo: null },
+  cosmetics: {},
+  swatch: () => "#c9a15a",
+  ground: { w: 20, h: 12 },
+  // plus the template's own draw, input and autopilot hooks (see BoardBootOptions)
+});
+```
+
+## Key API
+
+- `bootBoard(options)`: connects to the room, builds the stage and the HUD, and wires the store, stake and gear for a rules genre.
+- `joinBoard(adapter, join)` and `InputClock`: the room connection and the input clock for rules genres; `roomsEndpoint(params)` picks the room server from the page URL.
+- `BoardStage` and `fallbackShape`: the styled 3D stage and placeholder shapes.
+- `Hud`, `wireStore`, `$` and `cssColor`: the HUD shell and store panel.
+- `wireStake`, `wireGear`, `gearOf` and `wirePot`: the buy-in run, losable gear and pots.
+- `mockKit`: the in-page store backend used for local play.
+- `hostFlags`, `namedPlayer`, `onHostPlayer`, `postReady`, `storeNote`: how a page talks to the Net Forge studio or to kit play when it is embedded.
+
+To run a board game locally, use `@netforge/kit-play`.
+
+## Docs
+
+- https://forge.netnet.capital/docs/packages/tabletop
+
+## License
+
+MIT. See `LICENSE` and `NOTICE`.

package/package.json

@@ -1,11 +1,25 @@
 {
   "name": "@netforge/tabletop",
-  "version": "0.1.0",
-  "description": "The client kit the board-style templates share (tower defense, idle, card battler, monster collector): the room connection and input clock for rules genres, the styled 3D stage, the Kit store, stake and gear wiring, and the HUD shell.",
+  "version": "0.2.0",
+  "description": "Shared client kit for Net Forge board-style game templates (tower defense, idle, card battler, monster collector): room connection, input clock, 3D stage, store and HUD.",
+  "keywords": [
+    "game-engine",
+    "multiplayer",
+    "browser-game",
+    "threejs",
+    "tower-defense",
+    "card-game",
+    "idle-game",
+    "monster-collector",
+    "typescript",
+    "gamedev",
+    "net-forge"
+  ],
   "license": "MIT",
   "type": "module",
   "exports": {
-    ".": "./src/index.ts"
+    ".": "./src/index.ts",
+    "./package.json": "./package.json"
   },
   "files": [
     "src",
@@ -14,22 +28,26 @@
     "NOTICE",
     "LICENSE"
   ],
+  "sideEffects": false,
   "publishConfig": {
     "access": "public"
   },
+  "homepage": "https://forge.netnet.capital/docs/packages/tabletop",
+  "bugs": {
+    "url": "https://github.com/netnetdev/net-forge/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/netnetdev/net-forge.git",
     "directory": "packages/tabletop"
   },
-  "homepage": "https://github.com/netnetdev/net-forge/tree/main/packages/tabletop#readme",
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
     "three": "0.186.1",
-    "@netforge/asset-library": "0.1.0",
-    "@netforge/engine": "0.1.0"
+    "@netforge/asset-library": "0.2.0",
+    "@netforge/engine": "0.2.0"
   },
   "devDependencies": {
     "@types/node": "22.20.1",
@@ -37,9 +55,6 @@
     "typescript": "5.8.3",
     "vitest": "3.2.7"
   },
-  "bugs": {
-    "url": "https://github.com/netnetdev/net-forge/issues"
-  },
   "scripts": {
     "typecheck": "tsc -p tsconfig.json",
     "test": "vitest run --passWithNoTests"

package/src/boot.ts

@@ -167,7 +167,7 @@ export async function bootBoard<S>(o: BoardBootOptions<S>): Promise<BoardApp<S>>
   if (friendRoomId && conn.roomId !== friendRoomId) setTimeout(() => hud.toast("Room full, new room"), 500);
   if (conn.welcome.version !== o.version) setTimeout(() => hud.toast("Update ready. Reload."), 800);
   const autopilot = params.get("autopilot") === "1";
-  const linkFor = (base: string) => `${base}?room=${conn.roomId}${place !== o.place ? `&place=${encodeURIComponent(place)}` : ""}${params.has("server") ? `&server=${encodeURIComponent(endpoint)}` : ""}`;
+  const linkFor = (base: string) => `${base}?room=${conn.roomId}${place !== o.place ? `&place=${encodeURIComponent(place)}` : ""}${params.has("server") ? `&server=${encodeURIComponent(endpoint)}` : ""}${params.has("game") ? `&game=${encodeURIComponent(params.get("game") ?? "")}` : ""}`;
   const keep = ["autopilot", "webgl", "stats", "style", "preview", "shapes", "host", "coin", "title", "player", "library"].filter((k) => params.has(k)).map((k) => `&${k}=${encodeURIComponent(params.get(k) ?? "")}`).join("");
   history.replaceState(null, "", `${linkFor(location.pathname)}${keep}`);