acdream/docs
2026-07-22 16:52:50 +02:00
..
architecture refactor(app): compose world rendering startup 2026-07-22 16:46:05 +02:00
audit docs: update audit — Sprint 1 items verified (sequence counters + scenery LCG) 2026-04-13 13:51:39 +02:00
plans docs(architecture): plan retained UI and live presentation composition 2026-07-22 16:52:50 +02:00
research refactor(input): own gameplay action routing 2026-07-22 12:43:05 +02:00
superpowers fix(world): remove non-retail portal exit fade 2026-07-15 23:20:52 +02:00
bugs.md docs: reconcile project status and navigation 2026-07-20 13:00:41 +02:00
ISSUES.md refactor(settings): own two-phase runtime settings 2026-07-22 13:30:22 +02:00
README.md docs(architecture): close selection extraction slice 2026-07-21 09:04:31 +02:00

acdream documentation map

This page is the entry point for project documentation. It distinguishes current sources of truth from implementation history so an old plan or issue banner cannot silently override the current program state.

Current snapshot — 2026-07-21

  • Milestone state: M3, “Cast a spell,” landed 2026-07-21. M4, “Live in the world,” is next.
  • Active program: behavior-preserving GameWindow decomposition before new M4 subsystem work. The reconciled ownership ledger and slice order are in architecture/code-structure.md. Selection/interaction Slice 1 is complete; live animation presentation is next.
  • Completed gates: R6 locomotion/collision/projectile/teleport/radar and the final two-client portal-out/materialization observer comparison (#218).
  • Separate visual verification: the shared-alpha lifestone/particle result in #225; its connected resource-lifetime and performance routes pass.
  • Carried behavior debt: #153 (far teleport onto an unstreamed edge), #116 (two narrowed slide-response cases), and divergence rows TS-50/TS-51.
  • Deferred engineering tracks: Modern Pipeline MP1b+ and Linux/headless automation (Track LH). Neither is part of the active structural campaign.
  • Divergence audit: 178 active rows — IA 17, AD 37, AP 85, TS 34, and UN 5 — plus the retained retired TS-37 history note.
  • Latest automated baseline: Release build succeeds with 17 known test-project warnings (#228); 6,558 tests passed and 5 intentionally skipped. The unattended connected R6 route completed seven portal materializations, production input exercises, and a graceful close. See research/2026-07-20-connected-r6-soak.md.

Sources of truth

Read these in this order when deciding what to do next:

  1. plans/2026-05-12-milestones.md — the active playable outcome, freeze boundaries, and visual gates.
  2. plans/2026-04-11-roadmap.md — strategic phase ledger: shipped, active, deferred, and future work.
  3. ISSUES.md — tactical defects and small follow-ups. The status inside an issue is authoritative; physical order is not.
  4. architecture/retail-divergence-register.md — every known place runtime behavior can differ from retail.
  5. architecture/acdream-architecture.md and architecture/code-structure.md — ownership, dependency, update-thread, and extraction rules.
  6. architecture/worldbuilder-inventory.md — rendering/DAT code already owned in-tree versus mechanisms still ours to port.

If these disagree, milestones control the current outcome, the roadmap controls work ordering, the issue status controls the individual defect, and the architecture documents control implementation shape. Reconcile the stale document in the same change; do not leave both claims standing.

Research and implementation records

  • research/named-retail/ is the primary retail oracle: named pseudo-C, headers, symbols, and types from the Sept 2013 build.
  • research/decompiled/ is the older Ghidra fallback.
  • research/ contains focused pseudocode, traces, fixtures, and gate reports. A dated research note records evidence; it does not become a new roadmap.
  • superpowers/specs/ and superpowers/plans/ are per-slice design and execution records. Completed plans remain historical.
  • audit/ contains completion and conformance audits.

Durable memory

  • ../claude-memory/MEMORY.md indexes the live subsystem memories and the render/physics digests. Read a domain digest before changing that subsystem, especially its DO-NOT-RETRY table.
  • ../memory/ contains stable engineering references such as the modern rendering pipeline, two-tier streaming, and toolchain notes.

Memory accelerates recall; it does not outrank the canonical documents above. When current truth changes, update the relevant canonical document and distill only the durable lesson into memory.

Historical and deprecated documents

  • bugs.md is the April 2026 bug snapshot. It is preserved for archaeology and is not an active ledger.
  • Dated plans and specs describe the decision at that time. Their completion wording is historical unless the current milestone/roadmap explicitly links the item as active.
  • Old R1→R8 architecture sequencing is superseded. Current execution comes from the milestones and strategic roadmap.

Documentation maintenance rules

  • Update milestone, roadmap, issue, divergence, architecture, and memory claims in the same commit when a shipped change affects them.
  • Keep one issue ID per defect. Narrow an issue in place; do not reuse another issue's number as a shorthand.
  • Mark automated, connected, and visual gates separately. An automated pass is not a visual acceptance, and an RDP throughput sample is not a local-display visual comparison.
  • Preserve research history, but remove stale “current/next” claims from living documents once the state advances.