Skip to content

FEATURES

What the game does. Each doc answers four questions: what is this, what are the rules and numbers, what does the player do, where does the code implement it.

When the documented numbers and the code disagree, the code wins; surprising numbers are flagged inline.

This is also the only place where implementation status is tracked. The other doc sets (ARCHITECTURE, API, DATA_MODELS, OPERATIONS) describe the target design; status notes (shipped, partial, design-only, known bugs) live next to the relevant feature in this folder. See "Status convention" below.

Index

Definitions

  • definitions.md — Consolidated terminology, game rules, resource types, ship types, and galaxy components glossary.

Gameplay

Economy

Galaxy

Planets

Status convention

Implementation status is tagged inline next to the feature it describes, using a four-status convention:

Marker Meaning
✅ Shipped Implemented and reachable end-to-end.
🚧 Partial Some pieces in code, some pieces still missing.
📐 Design-only Documented intent; no code yet.
🐛 Bug Known runtime defect against the documented behavior.

Notes are written like:

Status: 🚧 Partial — short note. Pointer at where the target spec lives if cross-cutting (e.g., "see ARCHITECTURE/auth.md").

  • Data models: ../DATA_MODELS/ (entities, schema, FK relationships).
  • API surface: gameserver auto-publishes Swagger at <api-host>/docs and OpenAPI JSON at <api-host>/openapi.json. WebSocket protocol design lives in ../SYSTEMS/realtime-bus.md.
  • Architecture: ../ARCHITECTURE/ (services, deployment).