don
/
neon-sprawl
mirror of https://github.com/ViPro-Technologies/neon-sprawl
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
neon-sprawl/docs/decomposition/modules/documentation_and_implement...

12 KiB
Raw Blame History

Documentation and implementation alignment

The module dependency register Status column and each module’s summary table should not silently disagree with the repo. This doc defines how to keep decomposition docs truthful and where to record partial work.

Roles

Source Role
Register + module markdown Intent, dependencies, contracts, policies (authority, PvP, quests, ops).
Code + tests What actually runs; paths under server/, client/, etc.
Plans docs/plans/ (e.g. NEO-* implementation plans) tie stories to acceptance criteria.
Linear Issues under projects; module grouping = labels on the issue (no duplicate Feature tier). Decomposition README — Linear alignment.
This doc’s tracking table Quick inventory of modules that have started implementation; expand as work lands.

Status column (register)

Status Meaning
Planned No meaningful implementation toward this module yet, or only unrelated spikes.
In Progress At least one tracked story or code path exists toward the module; contracts may be partial.
Ready Exported contracts meet contracts.md “Ready” guidance and dependents may integrate.
Blocked Upstream module or external dependency prevents progress.

Rule: When a story merges that implements part of a module (API, store, schema), move that row from Planned to In Progress (or Ready when appropriate) in the same PR or a follow-up doc PR.

Partial modules stay In Progress until the prototype slice for that module is satisfied or contracts are explicitly frozen for dependents.

Per-module docs

Optional ## Implementation snapshot (or a short bullet under Summary) on a module page: one paragraph + links to docs/plans/…, server paths, and server README sections—avoid duplicating the full tracking table on every page.

The Summary table Status field should match the register row for that module.

Implementation tracking table

Rows appear when work starts; default for unlisted modules is Planned / not started.

Module Register status Snapshot Plans / pointers
E1.M1 Ready Prototype milestone Done (E1.M1). Authoritative PositionState + MoveCommand over HTTP (JSON v1 snap); in-memory store by default, Postgres when configured (NEO-8); shared NpgsqlDataSource disposed on host shutdown (NEO-13); Godot sync + path-follow (NEO-7, NEO-11); InteractionRequest + horizontal range (NEO-9). Follow-on: prediction/reconciliation, Slice 1 telemetry, Protobuf wire per contracts.md. NEO-6, NEO-7, NEO-8, NEO-9, NEO-10, NEO-11, NEO-13; server/NeonSprawl.Server/Game/PositionState/, Game/Interaction/; server README
E1.M2 Ready Slice 2 prototype slice closed: follow + CameraState (NEO-15); zoom bands (NEO-16); occlusion (NEO-17); occluder pick-through (NEO-20); contracts + hardening (NEO-18). Client-local; no server use of camera pose. NEO-15, NEO-16, NEO-17, NEO-18, NEO-20; client/scripts/isometric_follow_camera.gd, camera_state.gd, zoom_band_config.gd, occlusion_policy.gd, ground_pick.gd; E1_M2_IsometricCameraController.md
E1.M3 In Progress NEO-23 landed: JSON v1 targeting read + select (GET/POST …/target, Game/Targeting/, NEO-23) — PlayerTargetStateResponse / soft lock / reasonCode denials; wire name differs from illustrative TargetState in module doc (called out in plan + README). NEO-24 landed: client tab-target + lock HUD synced to server (NEO-24) — TargetSelectionClient (client/scripts/target_selection_client.gd), Tab / Esc bindings, TargetLockLabel HUD, hybrid movement-triggered refresh via new PositionAuthorityClient.authoritative_ack signal (fires on every server-confirmed position, boot + move-stream 200) with a 250 ms cooldown; manual QA in docs/manual-qa/NEO-24.md. NEO-25 landed: versioned GET /game/world/interactables (NEO-25) — InteractablesListResponse / InteractablesWorldApi in server/NeonSprawl.Server/Game/Interaction/; Godot interactables_catalog_client.gd + interactable_world_builder.gd (fetch-driven props + glow); server README — Interactable descriptors (NEO-25). NEO-26 landed: prototype SelectionEvent — TargetSelectionClient.selection_event (NEO-26) when lockedTargetId changes; optional log_selection_events. NEO-27 landed: Slice 3 telemetry hook sites documented — selection_event maps to product target_changed in target_selection_client.gd; server lock transition hook comments in InMemoryPlayerTargetLockStore; reserved ability_cast_requested / ability_cast_denied comments in client/scripts/main.gd (all TODO(E9.M1)); see NEO-27 and docs/manual-qa/NEO-27.md. Follow-on / still open: richer InteractableDescriptor consumers beyond list projection + existing POST …/interact; production telemetry ingest/catalog after E9.M1. Precursor (E1.M1): NEO-9 POST …/interact. Linear NEO-24–NEO-27; E1_M3_InteractionAndTargetingLayer.md; E1M3 prototype backlog; server README — Targeting, Interactable descriptors (NEO-25), Interaction
E1.M4 In Progress NEO-29 landed: prototype HotbarLoadout v1 server contract (GET/POST /game/players/{id}/hotbar-loadout) with stable deny reason codes, per-player scope, and persistence policy matching NEO-8/NS-17 (Postgres when configured, in-memory fallback otherwise). Client boot hydration is wired via hotbar_loadout_client.gd + hotbar_state.gd from main.gd; manual QA checklist created. NEO-31 landed: prototype POST /game/players/{id}/ability-cast, digit-key cast wiring from main.gd, ability_cast_client.gd, and hotbar_cast_slot_resolver.gd (target id from lockedTargetId in cached target state); GdUnit covers resolver + HTTP client; manual QA NEO-31. NEO-28 landed: cast POST validates lock + registry + range (invalid_target, out_of_range); AbilityCastClient.cast_result_received + CastFeedbackLabel HUD line; manual QA NEO-28. NEO-30 landed: Slice 3 cast funnel telemetry hook-site comments in AbilityCastApi.cs (ability_cast_requested on authoritative accept, ability_cast_denied + non-empty reasonCode on each JSON deny branch); client dev hooks unchanged; manual QA NEO-30; plan NEO-30. NEO-32 landed: GET /game/players/{id}/cooldown-snapshot + on_cooldown cast deny + prototype global cooldown commit; cooldown_snapshot_client.gd, cooldown_state.gd, CooldownSlotsLabel in main.gd; manual QA NEO-32; plan NEO-32. NEO-29, NEO-31, NEO-28, NEO-30, NEO-32; E1_M4_AbilityInputScaffold.md; E1M4 prototype backlog; server/NeonSprawl.Server/Game/AbilityInput/; client/scripts/hotbar_loadout_client.gd, client/scripts/hotbar_state.gd, client/scripts/ability_cast_client.gd, client/scripts/hotbar_cast_slot_resolver.gd, client/scripts/cooldown_snapshot_client.gd, client/scripts/cooldown_state.gd; server README — Hotbar loadout, Ability cast (NEO-31), Cooldown snapshot (NEO-32)
E2.M1 In Progress NEO-33 landed: frozen prototype trio salvage / refine / intrusion in content/skills/prototype_skills.json; PR gate + validate_content.py enforce schema, duplicate id, exact trio ids, and category coverage; designer note on allowedXpSourceKinds in E2_M1 + content/README.md. NEO-34 landed: fail-fast server load of content/skills/*.json at startup — server/NeonSprawl.Server/Game/Skills/ (NEO-34); config + discovery in server README — Skill catalog. NEO-35 landed: ISkillDefinitionRegistry / SkillDefinitionRegistry + DI (NEO-35). Follow-on: read HTTP + Bruno (NEO-36). NEO-33, NEO-34, NEO-35; E2_M1; module_dependency_register.md E2.M1 note; server/NeonSprawl.Server/Game/Skills/

Related docs