36122b500b
Add import/export feature bullet to README.md (constitution requires README updates when user-facing capabilities change). Add research scope note to CLAUDE.md RPI section: research phases should scan for existing patterns and consolidation opportunities, not just what the feature needs. Remove auto-generated Active Technologies / Recent Changes sections that duplicated Tech Stack. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# Encounter Console
|
|
|
|
A local-first initiative tracker and encounter manager for tabletop RPGs (D&D 5e / 2024). Runs entirely in the browser — no server, no account, no data leaves your machine.
|
|
|
|
## What it does
|
|
|
|
- **Initiative tracking** — add combatants (batch-add from bestiary, custom creatures with optional stats), roll initiative (manual or d20), cycle turns and rounds
|
|
- **Encounter state** — HP, AC, conditions, concentration tracking with visual status indicators
|
|
- **Bestiary integration** — import bestiary JSON sources, search creatures, and view full stat blocks
|
|
- **Player characters** — create reusable player character templates with name, AC, HP, color, and icon; search and add them to encounters with pre-filled stats; manage (edit/delete) from a dedicated panel
|
|
- **Undo/redo** — reverse any encounter action with Undo/Redo buttons or keyboard shortcuts (Ctrl+Z / Ctrl+Shift+Z, Cmd on Mac); history persists across page reloads
|
|
- **Import/export** — export the full encounter state (combatants, undo/redo history, player characters) as a JSON file or copy to clipboard; import from file upload or pasted JSON with validation and confirmation
|
|
- **Persistent** — encounters survive page reloads via localStorage; bestiary data cached in IndexedDB; player characters stored independently
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 22+
|
|
- pnpm 10.6+
|
|
|
|
## Getting Started
|
|
|
|
```sh
|
|
pnpm install
|
|
pnpm --filter web dev
|
|
```
|
|
|
|
Open `http://localhost:5173`.
|
|
|
|
## Scripts
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `pnpm --filter web dev` | Start the dev server |
|
|
| `pnpm --filter web build` | Production build |
|
|
| `pnpm test` | Run all tests (Vitest) |
|
|
| `pnpm check` | Full merge gate (knip, biome, typecheck, test, jscpd) |
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
apps/web/ React 19 + Vite — UI components, hooks, adapters
|
|
packages/domain/ Pure functions — state transitions, types, validation
|
|
packages/app/ Use cases — orchestrates domain via port interfaces
|
|
data/bestiary/ Bestiary index for creature search
|
|
scripts/ Build tooling (layer boundary checks, index generation)
|
|
specs/ Feature specifications (spec → plan → tasks)
|
|
```
|
|
|
|
## Architecture
|
|
|
|
Strict layered architecture with enforced dependency direction:
|
|
|
|
```
|
|
apps/web (adapters) → packages/application (use cases) → packages/domain (pure logic)
|
|
```
|
|
|
|
Domain is pure — no I/O, no randomness, no framework imports. Layer boundaries are enforced by automated import checks that run as part of the test suite. See [CLAUDE.md](./CLAUDE.md) for full conventions.
|
|
|