Skip to content

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 docStatusOne-line positioning
BigWorld–Apollo mappingAgreed rulesOriginal terms, Apollo roles, code and gaps
Can Apollo exceed BigWorld?Auditable assessmentPotential advantages, unproven claims, gaps, and acceptance criteria
World and cell managementReview draftShared binary, role startup, local autoscaling, placement, recovery, and migration
World Restart ReconciliationDesign draft (under review), not implementedjournal v2 record family, 963 self-report, per-item adjudication and conflict freezes
Seamless map and multi-Cell SpaceTarget design, staged implementationPartitioning, Ghosts, boundary AOI/combat, transfer, and takeover
Concept glossaryAgreed rulesEstablished names and responsibility boundaries
Player object modelSubsystem implementation noteBase persistent objects, Cell entities, and Instance gameplay lifecycles
Attribute system and syncSubsystem implementation noteAttribute data and visibility/synchronization mechanisms
Session and online directorySubsystem implementation noteBase ownership, Space/Cell/executor location, and session routing
Cross-server scenesReserved design; disabledServer affiliation, shared-scene admission, authority transfer, settlement, and return
Login flowSubsystem design draftloginServer/gateway authentication, Base/database loading, and World admission
Clock and timeDeliveredWall clock/tick/frame budget semantics

Combat ​

Design docStatusOne-line positioning
Battle determinismDeliveredFour constraints + recording/replay/hash chain
Battle instance offloadSubsystem implementation noteBattle-computation offload experiment; does not change Instance/World target terms
Battle verification serviceDesign draft (under review)Client-authoritative battle recomputation and reconciliation (verifier)

Networking and Operations ​

Design docStatusOne-line positioning
Network abstraction and transport kernelDesign draftL0-L3 layering + M1 homegrown kernel (nng replacement route)
Gateway responsibilities and update boundaryArchitecture noteGateway routing, multiple instances, and update limits
Logging systemDelivered (P3-3 batches A/B/C)One unified closure + structured lines + three-prohibitions discipline
Log collectorImplementation noteLog collection executable and structured-log wiring
Crash captureDeliveredCrashpad out-of-process + symbolization pipeline
Capacity and benchmarkDelivered5000 CCU capacity model + three-model benchmark

Extension Surfaces ​

Design docStatusOne-line positioning
Simulation single-writerConcurrency designConcurrency boundary between network acceptance and instance simulation
Scripting system (Lua)Design draftBoth-end shared battle logic and hot-update discipline
SDK contractLiving documentClient/server shared contract (contract.lua)
XML contract generationDeliveredentities.xml → three-language projections

Released under the MIT License