Skip to content

Commit 7080b63

Browse files
cursoragenttimfox
andcommitted
docs: link Forward+ audit and minimal game shell from CLAUDE and QUICKSTART
CLAUDE.md Reference: add FORWARD_PLUS_PIPELINE_AUDIT.md and MINIMAL_GAME_SHELL.md. QUICKSTART renderer section: optional r_forwardPlus note with links to RENDERERS and the pipeline audit. Co-authored-by: Tim Fox <timfox@outlook.com>
1 parent 80ebf76 commit 7080b63

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,10 +451,12 @@ All significant changes require architectural review:
451451
### Key Documents
452452
- **[ARCHITECTURE.md](docs/ARCHITECTURE.md)**: High-level architectural overview
453453
- **[RENDERERS.md](docs/RENDERERS.md)**: Renderer architecture and features
454+
- **[FORWARD_PLUS_PIPELINE_AUDIT.md](docs/FORWARD_PLUS_PIPELINE_AUDIT.md)**: Vulkan Forward+ scaffolding (SSBOs, compute cull, PBR fragment path, Tier A hooks)
454455
- **[BRANCHES.md](docs/BRANCHES.md)**: Development philosophy
455456
- **[ROADMAP.md](docs/ROADMAP.md)**: Development priorities
456457
- **[DEVELOPMENT_SETUP.md](docs/DEVELOPMENT_SETUP.md)**: Development environment
457458
- **[QUICKSTART.md](docs/QUICKSTART.md)**: End-user quick start (download, game data, run)
459+
- **[MINIMAL_GAME_SHELL.md](docs/MINIMAL_GAME_SHELL.md)**: Smallest valid `base/` + `.pk3` bootstrap (engine-only / tech demo)
458460
- **[RELEASE_CHECKLIST.md](docs/RELEASE_CHECKLIST.md)**: Pre-release validation and release steps
459461

460462
### Build Scripts

docs/QUICKSTART.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ The default renderer is Vulkan. To use OpenGL instead:
8181

8282
**PBR (Physically Based Rendering)** is on by default when using Vulkan with FBO. Ensure `r_fbo 1` (default) and `r_pbr 1` (default). If PBR is disabled at startup, the console will show why (e.g. "requires r_fbo 1"). Use `vid_restart` after changing these.
8383

84+
**Optional Forward+ scaffolding (Vulkan, advanced):** `r_forwardPlus 1` (default **0**, **latched**; `vid_restart` to toggle) enables GPU light records + per-tile compute cull and optional PBR debug/shade cvars—see [RENDERERS.md](RENDERERS.md#vulkan-forward-scaffolding) and the pipeline audit [FORWARD_PLUS_PIPELINE_AUDIT.md](FORWARD_PLUS_PIPELINE_AUDIT.md).
85+
8486
## Steam Deck
8587

8688
When running under Steam on Steam Deck, the engine auto-detects the device and loads `base/steamdeck.cfg` (gamepad enabled, Vulkan, 60 FPS cap). Ensure `steamdeck.cfg` exists in your base folder. Build with `-DUSE_STEAM=ON -DSTEAMWORKS_SDK=/path/to/sdk` for full Steam API support.

0 commit comments

Comments
 (0)