aaron/darkwatch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update handbook for atmosphere polish and brochure site

Browse source
This commit is contained in:
Aaron Wood 2026-04-11 22:24:43 -04:00
parent 348cfb573e
commit 97954de110
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/HANDBOOK.md
View file

@ -1,6 +1,6 @@
# Darkwatch Handbook # Darkwatch Handbook
**Last updated:** 2026-04-12 **Last updated:** 2026-04-11
A reference for everyone working on or with Darkwatch — whether you're a DM discovering the tool, a developer joining the project, or a collaborator adding features. A reference for everyone working on or with Darkwatch — whether you're a DM discovering the tool, a developer joining the project, or a collaborator adding features.
@ -84,11 +84,12 @@ Each character has a luck token toggle. Players and the DM can both see and togg
The DM can layer atmosphere effects that all players see in real time: The DM can layer atmosphere effects that all players see in real time:
- **Fog** — a dark gradient overlay with adjustable intensity - **Fog** — drifting radial-gradient layers with adjustable intensity; fades in smoothly when enabled
- **Fire** — Three.js particle simulation, full screen - **Fire** — Three.js GLSL shader with a realistic colour ramp (deep red tips → orange → amber → warm yellow core), per-column height variation for a ragged silhouette, and ember glow at the base
- **Rain / Embers** — tsParticles overlay - **Rain** — translucent blue-white drops that increase in density with intensity; at high intensity the angle tilts slightly, simulating wind-driven rain
- **Embers** — small slow-drifting sparks with flickering opacity; more numerous and finer than rain
Atmosphere is DM-only to control; all players see the active effects. Each effect has an independent intensity slider. Atmosphere is DM-only to control; all players see the active effects.
### Initiative Tracker ### Initiative Tracker
@ -121,7 +122,7 @@ Features currently planned or in progress:
- **Snow atmosphere effect** — tsParticles, evaluating after DM feedback on existing effects - **Snow atmosphere effect** — tsParticles, evaluating after DM feedback on existing effects
- **Ambient audio** — optional background sound; low priority - **Ambient audio** — optional background sound; low priority
Longer-term ideas: multi-system support (Cairn, Knave, Cyberpunk RED), profile image uploads, metrics and analytics, API documentation, and a public marketing site. Longer-term ideas: multi-system support (Cairn, Knave, Cyberpunk RED), profile image uploads, metrics and analytics, and API documentation.
## Known limitations ## Known limitations
@ -222,6 +223,12 @@ shadowdark/
│ │ ├── types.ts # Shared TypeScript types │ │ ├── types.ts # Shared TypeScript types
│ │ └── socket.ts # Socket.IO singleton │ │ └── socket.ts # Socket.IO singleton
│ └── public/ # Static assets (dice themes, etc.) │ └── public/ # Static assets (dice themes, etc.)
├── site/ # Static marketing brochure (no build step)
│ ├── index.html # Single-page brochure
│ ├── style.css # All brochure styles
│ ├── main.js # Smooth scroll + hero parallax
│ ├── screenshots.js # Playwright script — regenerates screenshots
│ └── assets/screenshots/ # Committed PNGs used by the brochure
├── server/ ├── server/
│ ├── src/ │ ├── src/
│ │ ├── routes/ # Express REST routes + socket handler files │ │ ├── routes/ # Express REST routes + socket handler files