[FEATURE] Player walkthrough / guide at /guide #80

New issue

Closed

opened 2026-10-21 03:13:03 +02:00 by agent-claude · 1 comment

agent-claude commented

2026-10-21 03:13:03 +02:00

Collaborator

Build a player-facing Walkthrough / Guide for Rico's World served at https://ricosworld.themels.online/guide.

Static page shipped with the client build (second Vite entry client/guide/index.html) so npm run deploy publishes it.
16-bit SNES look matching the game; mobile-friendly with table of contents.
Getting started / first days walkthrough + reference section per system (needs/mood, work, construction, bills, research, farming/food, temperature/apparel, power, rooms/beauty, recreation, health, diseases, wildlife/predators/taming, raids/combat, prisoners, events, trade/world map, offline protection, shortcuts).
"Guide" link from the login screen and HUD.
Avoid hard-coding pacing numbers that are being retuned.

Build a player-facing Walkthrough / Guide for Rico's World served at https://ricosworld.themels.online/guide. - Static page shipped with the client build (second Vite entry `client/guide/index.html`) so `npm run deploy` publishes it. - 16-bit SNES look matching the game; mobile-friendly with table of contents. - Getting started / first days walkthrough + reference section per system (needs/mood, work, construction, bills, research, farming/food, temperature/apparel, power, rooms/beauty, recreation, health, diseases, wildlife/predators/taming, raids/combat, prisoners, events, trade/world map, offline protection, shortcuts). - "Guide" link from the login screen and HUD. - Avoid hard-coding pacing numbers that are being retuned.

agent-claude added the

agent/claude

type/feature

labels

2026-10-21 03:13:03 +02:00

agent-bot referenced this issue from a commit

2026-10-21 03:22:55 +02:00

feat: player walkthrough & systems guide at /guide (#80)

agent-claude referenced this issue from a pull request that will close it,

2026-10-21 03:23:06 +02:00

[PR] Player walkthrough & systems guide at /guide #81

agent-bot referenced this issue from a commit

2026-10-21 03:23:22 +02:00

Merge branch 'claude/80-player-guide' into main (#81)

agent-claude commented

2026-10-21 03:23:59 +02:00

Author

Collaborator

Handoff: player guide shipped (PR #81, merge `70c0db0`, deployed)

What was completed

client/guide/index.html: the Pioneer's Guide. It has a walkthrough (scenarios, landing site, screen tour, first days, first year) and a reference section for every current system, through animal taming.
client/src/guide.css / client/src/guide.ts: 16-bit window styling using the game's tokens and font, a sticky contents sidebar with scroll-spy, and a mobile drawer.
client/vite.config.ts: second rollup input. The build emits dist/guide/index.html, which npm run deploy ships. nginx's existing try_files $uri $uri/ /index.html 301s /guide to /guide/. No server config change was needed.
Links: the login card, a 📖 HUD button next to ?, and the controls overlay, which now also lists P and E. Added a book pixel icon in ui-icons.ts.
Live at https://ricosworld.themels.online/guide (version.json sha 70c0db0).

What remains

When the pacing retune merges, re-read the guide's relative timing wording (raids "every few weeks", grace period, crop growth "several days", seasons). No exact tick or day numbers are hard-coded, but the wording should still match the new feel.
ARCHITECT_TOOLS sub-labels in client/src/main.ts show costs that don't match content/buildings.json, which is what the sim charges. Examples: Timber Door "5" vs 3, Wooden Bed "6" vs 8, Machining Table "15 Slate, 10 Alloy" vs 6 alloy.
When a new system ships, add a section to the guide (and a TOC entry) alongside its docs/GAME_DESIGN.md section.

Gotchas

The guide is plain static HTML. Content lives in client/guide/index.html and isn't generated from content JSON, so cost, chance and stat tables need manual updates when content/*.json changes.
In vite dev the page is at http://localhost:5173/guide/, with the trailing slash.

## Handoff: player guide shipped (PR #81, merge 70c0db0, deployed) **What was completed** - `client/guide/index.html`: the Pioneer's Guide. It has a walkthrough (scenarios, landing site, screen tour, first days, first year) and a reference section for every current system, through animal taming. - `client/src/guide.css` / `client/src/guide.ts`: 16-bit window styling using the game's tokens and font, a sticky contents sidebar with scroll-spy, and a mobile drawer. - `client/vite.config.ts`: second rollup input. The build emits `dist/guide/index.html`, which `npm run deploy` ships. nginx's existing `try_files $uri $uri/ /index.html` 301s `/guide` to `/guide/`. No server config change was needed. - Links: the login card, a 📖 HUD button next to `?`, and the controls overlay, which now also lists P and E. Added a `book` pixel icon in `ui-icons.ts`. - Live at https://ricosworld.themels.online/guide (version.json sha 70c0db0). **What remains** - When the pacing retune merges, re-read the guide's relative timing wording (raids "every few weeks", grace period, crop growth "several days", seasons). No exact tick or day numbers are hard-coded, but the wording should still match the new feel. - `ARCHITECT_TOOLS` sub-labels in `client/src/main.ts` show costs that don't match `content/buildings.json`, which is what the sim charges. Examples: Timber Door "5" vs 3, Wooden Bed "6" vs 8, Machining Table "15 Slate, 10 Alloy" vs 6 alloy. - When a new system ships, add a section to the guide (and a TOC entry) alongside its `docs/GAME_DESIGN.md` section. **Gotchas** - The guide is plain static HTML. Content lives in `client/guide/index.html` and isn't generated from content JSON, so cost, chance and stat tables need manual updates when `content/*.json` changes. - In `vite dev` the page is at `http://localhost:5173/guide/`, with the trailing slash.

agent-claude closed this issue

2026-10-21 03:24:24 +02:00