docs: align architecture and physics API with 2026 layout#285
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: align architecture and physics API with 2026 layout#285cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
- Rewrite ARCHITECTURE.md directory tree for engine/runtime/modules layout - Add Box3D Soft Step physics frame diagram and fix stale src/ path refs - Expand LUA_API.md Engine.Physics (ragdoll, DMM, event poll, full surface) - Document PhysEvent_Poll types and pollEvent() usage in PHYSICS.md - Fix DISTRICTS.md and docs/README.md canonical path notes (Phase 5e) Co-authored-by: Tim Fox <timfox@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Weekly documentation pass for recently changed subsystems with stale or incomplete docs.
Docs updated
docs/ARCHITECTURE.mdsrc/tree with 2026engine//runtime//modules/layout; added Box3D Soft Step frame diagram; fixed VM/FS path referencesdocs/LUA_API.mdEngine.Physicsfrom outdated "6 functions" stub to full API surface (shapes, constraints, event poll, ragdoll, DMM)docs/PHYSICS.mdPhysEvent_Poll,pollEvent()fields, type table, Lua loop example)docs/DISTRICTS.mdmodules/world/,runtime/client/world/)docs/README.mdsrc/*shims)Codepaths covered
modules/physics/*— Box3D Soft Step, ProcAnim/motor ragdoll, DMM fracture,phys_eventsruntime/game/g_lua_bindings.c—Engine.Physics.*Lua surfacemodules/world/world_district.cpp+runtime/client/world/cl_district.cpp— district residencyengine/core/vm.c,files.c— native module loading referencesKey knowledge gaps addressed
src/treepollEvent()vssubscribe()for the physics event bussrc/*paths were authoritative after Phase 5eTest plan
./tests/scripts/test_physics.sh(doc symbol + path checks)./scripts/smoke_test.shnot required (documentation-only PR)