|
1 | 1 | # Stroll — feature reference |
2 | 2 |
|
3 | | -Quick reference for players and maintainers. Default build is **peaceful** (`FEATURE_WEAPON = false` in `config.js`). |
| 3 | +Default build: `FEATURE_WEAPON = false`, `FEATURE_MINIGAMES = true` in `config.js`. |
4 | 4 |
|
5 | 5 | ## Controls |
6 | 6 |
|
7 | 7 | | Key | Action | |
8 | 8 | |-----|--------| |
9 | | -| W A S D / arrows | Walk | |
10 | | -| Mouse | Look (click to lock pointer) | |
11 | | -| Right click | Bloom nearby flowers | |
12 | | -| M | Toggle ambient sound | |
13 | | -| P | Photo mode (orbit, filters, screenshot) | |
14 | | -| N | Meditation / breathing | |
15 | | -| B | Cycle ambient mood (calm → nature → meditative → dreamy) | |
16 | | -| J | Discovery journal | |
17 | | -| R | Toggle rain | |
18 | | -| G | Treasure hunt or breathing mini-game (random) | |
19 | | -| Esc | Pause (or close journal) | |
20 | | - |
21 | | -When `FEATURE_WEAPON` is `true`: left click shoots; ammo HUD appears. |
22 | | - |
23 | | -## Mini-games |
24 | | - |
25 | | -Only **treasure hunt** and **breathing** are fully wired in the update loop. Press **G** again to end and see your score. |
26 | | - |
27 | | -## Achievements |
28 | | - |
29 | | -Tracked in `challenges.js` using stats from `game-state.js` (distance, night seen, photos, flowers, collectibles, waypoints). |
30 | | - |
31 | | -## Build & deploy |
| 9 | +| WASD | Move | |
| 10 | +| Mouse | Look (pointer lock) | |
| 11 | +| RMB | Flowers | |
| 12 | +| M | Sound | |
| 13 | +| P | Photo | |
| 14 | +| N | Rest | |
| 15 | +| B | Ambience preset | |
| 16 | +| J | Journal | |
| 17 | +| R | Rain | |
| 18 | +| G | Activity | |
| 19 | +| Esc | Pause / close journal | |
| 20 | + |
| 21 | +## Build |
32 | 22 |
|
33 | 23 | ```bash |
34 | 24 | npm install |
35 | | -npm run dev # Vite dev server |
36 | | -npm run build # dist/ for static hosting |
37 | | -BASE_PATH=/Stroll/ npm run build # GitHub Pages (neutral-Stage/Stroll) |
38 | | -npm test # Playwright smoke tests |
| 25 | +npm run dev |
| 26 | +npm run build |
| 27 | +BASE_PATH=/Stroll/ npm run build # GitHub Pages |
| 28 | +npm test |
39 | 29 | ``` |
40 | 30 |
|
41 | | -Raw `index.html` still works without a build (CDN import map for Three.js). |
42 | | - |
43 | | -## Feature flags (`config.js`) |
44 | | - |
45 | | -| Flag | Default | Effect | |
46 | | -|------|---------|--------| |
47 | | -| `FEATURE_WEAPON` | `false` | FPS weapon, destructibles, ammo pickups | |
48 | | -| `FEATURE_MINIGAMES` | `true` | **G** key treasure / breathing | |
| 31 | +Unbundled `index.html` remains valid for static hosting via the import map. |
0 commit comments