Design Docs Overview
This directory contains design and implementation notes for individual capabilities. Apollo's target architecture, public terminology, and process boundaries are defined by the Architecture Overview and Concepts and Names; subsystem documents must not introduce a second process topology. This directory contains implementation notes and subsystem designs. Do not infer current code status from old batch notes. External engine terminology is comparative material, not automatically an Apollo concept. The only current project backlog is the root
todo.md.
Foundations and Models
| Design doc | Status | One-line positioning |
|---|---|---|
| BigWorld–Apollo mapping | Agreed rules | Original terms, Apollo roles, code and gaps |
| Can Apollo exceed BigWorld? | Auditable assessment | Potential advantages, unproven claims, gaps, and acceptance criteria |
| World and cell management | Review draft | Shared binary, role startup, local autoscaling, placement, recovery, and migration |
| World Restart Reconciliation | Design draft (under review), not implemented | journal v2 record family, 963 self-report, per-item adjudication and conflict freezes |
| Seamless map and multi-Cell Space | Target design, staged implementation | Partitioning, Ghosts, boundary AOI/combat, transfer, and takeover |
| Concept glossary | Agreed rules | Established names and responsibility boundaries |
| Player object model | Subsystem implementation note | Base persistent objects, Cell entities, and Instance gameplay lifecycles |
| Attribute system and sync | Subsystem implementation note | Attribute data and visibility/synchronization mechanisms |
| Session and online directory | Subsystem implementation note | Base ownership, Space/Cell/executor location, and session routing |
| Cross-server scenes | Reserved design; disabled | Server affiliation, shared-scene admission, authority transfer, settlement, and return |
| Login flow | Subsystem design draft | loginServer/gateway authentication, Base/database loading, and World admission |
| Clock and time | Delivered | Wall clock/tick/frame budget semantics |
Combat
| Design doc | Status | One-line positioning |
|---|---|---|
| Battle determinism | Delivered | Four constraints + recording/replay/hash chain |
| Battle instance offload | Subsystem implementation note | Battle-computation offload experiment; does not change Instance/World target terms |
| Battle verification service | Design draft (under review) | Client-authoritative battle recomputation and reconciliation (verifier) |
Networking and Operations
| Design doc | Status | One-line positioning |
|---|---|---|
| Network abstraction and transport kernel | Design draft | L0-L3 layering + M1 homegrown kernel (nng replacement route) |
| Gateway responsibilities and update boundary | Architecture note | Gateway routing, multiple instances, and update limits |
| Logging system | Delivered (P3-3 batches A/B/C) | One unified closure + structured lines + three-prohibitions discipline |
| Log collector | Implementation note | Log collection executable and structured-log wiring |
| Crash capture | Delivered | Crashpad out-of-process + symbolization pipeline |
| Capacity and benchmark | Delivered | 5000 CCU capacity model + three-model benchmark |
Extension Surfaces
| Design doc | Status | One-line positioning |
|---|---|---|
| Simulation single-writer | Concurrency design | Concurrency boundary between network acceptance and instance simulation |
| Scripting system (Lua) | Design draft | Both-end shared battle logic and hot-update discipline |
| SDK contract | Living document | Client/server shared contract (contract.lua) |
| XML contract generation | Delivered | entities.xml → three-language projections |
