Add Egyptian escape room digital lock web app.

React/Vite lock UI with color-coded inputs, celebration SFX, and unlock video; Docker/nginx packaging and homelab deploy scripts documented in AGENTS.md.
2026-06-11 09:10:56 -04:00
parent 7daf88fee6
commit 32a0331e8b
35 changed files with 3780 additions and 0 deletions
@@ -0,0 +1,87 @@
+# Agent context — Egyptian Escape Room Digital Lock
+
+Homeschool Egyptian-themed escape room: a browser-based digital lock. Players enter numeric answers from color-coded puzzles; correct code triggers celebration and an unlock video.
+
+## Puzzle mapping
+
+| Color | Hex | Answer |
+|-------|-----|--------|
+| Red | `#ee1c11` | 8 |
+| Orange | `#ed7910` | 9 |
+| Yellow | `#eed611` | 10 |
+| Green | `#259e34` | 6 |
+| Cyan | `#1adcd1` | 8 |
+| Blue | `#1b54db` | 6 |
+| Purple | `#841adc` | 12 |
+| Magenta | `#dc18d4` | 4 |
+
+All inputs allow up to 2 digits; validation uses numeric comparison (`8` and `08` both match answer `8`). Combined code: `8910686124`.
+
+Answers are in client-side `src/lockConfig.ts` — acceptable for a kids' escape room, not a security boundary.
+
+## Success flow
+
+Wrong code → UNLOCK button jiggles + "Incorrect Code!" banner. Correct code → lock animation + confetti (~2s) → fullscreen autoplay of configured MP4 (no reset).
+
+## Media assets
+
+**Source folder** (WSL: `/mnt/lockbox/storage/...`; Unraid: `/mnt/user/storage/...`):
+
+`Documents/Home School Projects/Egyptian Escape Room/`
+
+Copied into each environment via setup scripts. Runtime config: `/media/config.json` (see `config.json.example`).
+
+| File | Role |
+|------|------|
+| `unlock.mp4` | Success video (`Ted Escape Room 1-5.mp4`) |
+| `incorrect.mp3` | Wrong-code sound on UNLOCK |
+| `unlock-confirm.mp3` | Success chime with confetti |
+| `celebration-pop.mp3` | Balloon pop at confetti start |
+| `celebration-horn.mp3` | Party horn — plays with pop; first 2s only |
+
+| Environment | Host path |
+|-------------|-----------|
+| Local dev | `public/media/` (via `scripts/setup-dev-media.sh`) |
+| Production | `/mnt/user/appdata/egyptian-escape-room/public/` (via `scripts/setup-prod-media.sh`) |
+
+## Local development
+
+```bash
+npm install
+./scripts/setup-dev-media.sh   # copy video + celebration MP3s → public/media/
+npm run dev                    # http://localhost:5173
+npm run dev -- --host          # LAN access for iPad testing
+```
+
+## Docker
+
+Requires **Docker Desktop** with WSL integration on the dev workstation. If `docker` is not found, stop and open Docker Desktop, then retry — see homelab [AGENTS.md](https://gitea.apps.lockleartech.com/clocklear/homelab/src/branch/main/AGENTS.md) § “Docker CLI in WSL”.
+
+```bash
+./scripts/setup-dev-media.sh
+docker compose -f docker-compose.local.yml up --build   # http://localhost:8080
+./scripts/build-push.sh                                 # push to homelab registry
+```
+
+Image: `docker-registry.apps.lockleartech.com/egyptian-escape-room:latest`
+
+Registry login uses an Authentik app password — see homelab [docs/authentik.md](https://gitea.apps.lockleartech.com/clocklear/homelab/src/branch/main/docs/authentik.md).
+
+## Homelab deployment
+
+| Item | Value |
+|------|-------|
+| Stack | `egyptian-escape-room` |
+| Hostname | `https://egyptian-escape-room.locklear.net` (LAN-only, `internal-only@file`) |
+| Endpoint | Portainer `Lockbox` (`10.1.0.2`) |
+| Appdata | `/mnt/user/appdata/egyptian-escape-room/public` → container `/media:ro` |
+| Compose snapshot | homelab `lockbox/portainer-traefik/backup/compose/egyptian-escape-room.yml` |
+
+Deploy order: `setup-prod-media.sh` on Unraid → build/push image → create/update Portainer stack.
+
+## Repo layout
+
+- `src/lockConfig.ts` — puzzle colors and answers
+- `src/DigitalLock.tsx` — main UI
+- `public/media/` — dev media (gitignored copies)
+- `scripts/setup-dev-media.sh`, `scripts/setup-prod-media.sh`, `scripts/build-push.sh`