Skip to content

Commit 0adcd1a

Browse files
committed
docs: document the in-game stats HUD overlay
1 parent 497acd8 commit 0adcd1a

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

‎docs/ARCHITECTURE.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,13 @@ Each scene receives shared resources (`TextureManager`, `audioManager`,
135135
`NetworkManager`) instead of owning them, so assets and the connection
136136
persist across scene transitions.
137137

138+
The in-game scene also owns a permanent [`Hud`](../gui/src/Scene/Hud.hpp)
139+
overlay rendered on top of the 3D view every frame: a top bar (solid-color
140+
panel via the `panel` shader + text via the `text` shader) displaying the map
141+
size, frequency, player/egg totals, per-team counts (color-coded), and the
142+
player-per-level distribution. It recomputes its strings from the `GameState`
143+
each frame and caches them to avoid rebuilding text geometry when unchanged.
144+
138145
### Networking & game state
139146

140147
[`NetworkManager`](../gui/src/Network/NetworkManager.hpp) wraps an

‎docs/USAGE.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ that address/port **before** starting the GUI.
4848
menu, before connecting and entering the game view (see
4949
[`SceneManager`](../gui/src/SceneManager/SceneManager.hpp) for the full
5050
scene flow).
51+
- Once in the game view, a permanent **HUD bar** at the top of the window shows
52+
live stats: map size, server frequency, total players, eggs, the player count
53+
per team (color-coded), and the number of players at each level (1–8). See
54+
[`Hud`](../gui/src/Scene/Hud.hpp).
5155

5256
## Running the bundled AI client
5357

0 commit comments

Comments
 (0)