Skip to content

docs: open-world, residency, and graph compute alignment#247

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-a360
Draft

docs: open-world, residency, and graph compute alignment#247
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-a360

Conversation

@cursor

@cursor cursor Bot commented Jun 7, 2026

Copy link
Copy Markdown

Summary

Documentation pass for recently landed open-world subsystems: sector streaming, consistent submodular residency, and sector-graph reachability (CPU + optional Vulkan BFS).

Docs added/updated

File Changes
docs/ARCHITECTURE.md src/world/ module map, vk_graph_bfs / tr_bsp_stream, CL_OpenWorld_Frame game-loop hook, planner selection flow
docs/DEVELOPMENT_SETUP.md Open-world / residency / graph-compute ctest matrix
docs/GRAPH_COMPUTE.md Vulkan compute enable path (r_graphCompute + vid_restart), troubleshooting, r_graphBlockUnloaded
docs/OPEN_WORLD.md nav_bake_sector / nav_bake_view console commands
docs/ROADMAP.md Open-world subsystem status (done vs in-progress)
docs/CONTRIBUTING.md Open-world test names for contributors
AGENTS.md World residency + sector graph gotchas
CLAUDE.md Reference links to OPEN_WORLD, WORLD_RESIDENCY, GRAPH_COMPUTE

Codepaths covered

  • src/world/world_open.c — sector coordinator + legacy disk vs residency delegate
  • src/world/world_residency.c — cardinality planner, MP allow-list
  • src/world/sector_graph.c — k-hop BFS pre-filter
  • src/renderers/vulkan/vk_graph_bfs.c — optional GPU BFS
  • src/client/cl_openworld.cpp — client frame bridge + nav bake commands
  • src/server/sv_openworld.c — server collision residency + MP sync

Knowledge gaps addressed

  • Architecture visibility: src/world/ was absent from the architecture overview despite being a first-class subsystem.
  • Operational runbook: how to enable GPU graph BFS (vid_restart requirement) and which ctests validate each layer.
  • Developer onboarding: ROADMAP and CLAUDE reference sections now point to the three open-world docs.
  • Console surface: nav_bake_* commands were implemented but missing from the OPEN_WORLD console table.
Open in Web View Automation 

- ARCHITECTURE.md: add src/world/, vk_graph_bfs, tr_bsp_stream, frame loop
- DEVELOPMENT_SETUP.md + CONTRIBUTING.md: ctest matrix for open-world tests
- GRAPH_COMPUTE.md: Vulkan compute enable path and troubleshooting
- OPEN_WORLD.md: document nav_bake console commands
- ROADMAP.md: open-world subsystem status section
- AGENTS.md + CLAUDE.md: cross-reference new operational docs

Co-authored-by: Tim Fox <timfox@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant