hypercross
/
boardgame-phaser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update Agents.md

This commit is contained in:
hypercross 2026-04-05 09:51:49 +08:00
parent acb2fc82ba
commit 0e7aaea7da
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
AGENTS.md
View File

@ -9,35 +9,34 @@ A Phaser 3 framework for building web board games, built on top of `boardgame-co
## boardgame-core Usage ## boardgame-core Usage
For detailed boardgame-core API documentation and examples, see **[boardgame-core Guide](docs/boardgame-core-guide.md)**. For detailed boardgame-core API documentation and examples, see `packages/framework/node_modules/boardgame-core/`
Key concepts: Key concepts:
- **MutableSignal** — Reactive state container with `.value` and `.produce()` - **MutableSignal** — Reactive state container with `.value` and `.produce()`
- **Command System** — CLI-style parsing with schema validation and prompt support - **Command System** — CLI-style parsing with schema validation and prompt support
- **Region System** — Spatial management with `createRegion()`, `applyAlign()`, `shuffle()`, `moveToRegion()` - **Region System** — Spatial management with `createRegion()`, `applyAlign()`, `shuffle()`, `moveToRegion()`
- **Part System** — Game pieces with `createPart()`, `createPartPool()`, `flip()`, `roll()` - **Part System** — Game pieces with `createPartsFromTable()`, `flip()`, `roll()`
- **RNG** — Deterministic PRNG via `createRNG(seed)` for reproducible game states - **RNG** — Deterministic PRNG via `createRNG(seed)` for reproducible game states
### Quick Example ### Quick Example
```ts ```ts
import { createGameCommandRegistry, createRegion, MutableSignal } from 'boardgame-core'; import { createGameCommandRegistry, createRegion, IGameContext } from 'boardgame-core';
type GameState = { type GameState = {
board: Region; board: Region;
parts: Part<{ player: 'X' | 'O' }>[]; parts: Part<{ player: 'X' | 'O' }>[];
currentPlayer: 'X' | 'O'; currentPlayer: 'X' | 'O';
}; };
type Game = IGameContext<GameState>;
const registration = createGameCommandRegistry<GameState>(); const registry = createGameCommandRegistry<GameState>();
export const registry = registration.registry;
registration.add('place <row:number> <col:number>', async function(cmd) { registry.register('place <row:number> <col:number>', async function(game: Game, row: number, col: number) {
const [row, col] = cmd.params as [number, number]; await game.produceAsync(state => {
this.context.produce(state => {
state.parts.push({ id: `p-${row}-${col}`, regionId: 'board', position: [row, col], player: state.currentPlayer }); state.parts.push({ id: `p-${row}-${col}`, regionId: 'board', position: [row, col], player: state.currentPlayer });
}); });
return { success: true }; return true;
}); });
``` ```
@ -71,7 +70,7 @@ pnpm --filter sample-game typecheck # tsc --noEmit (add to scripts first)
```bash ```bash
# boardgame-core is a local dependency via symlink (link:../../../boardgame-core) # boardgame-core is a local dependency via symlink (link:../../../boardgame-core)
# After changes to boardgame-core, simply rebuild it: # After changes to boardgame-core, simply rebuild it:
cd ../boardgame-core && pnpm build cd ../boardgame-core && npm build
# The symlink automatically resolves to the updated dist/ # The symlink automatically resolves to the updated dist/
``` ```