Diagram Assets¶
Editable sources and committed SVG renders for NXSand architecture and game logic. Regenerate when simulation, save format, scene flow, or module boundaries change.
Regenerate (uml-mcp / Kroki)¶
Regenerate with uml-mcp generate_uml (diagram_type mermaid) or python scripts/regenerate-diagrams.py (Kroki; may 403 on some networks). Pass output_dir as docs/diagrams and match SVG names in the table below.
Catalog¶
| Topic | Source | SVG |
|---|---|---|
| CI / release zips | ci-release-flow.mmd |
ci-release-flow.svg |
| Launch & save sequence | nxsand-launch-flow.mmd |
nxsand-launch-flow.svg |
| Play frame GPU path | sim-pipeline.mmd |
sim-pipeline.svg |
| Source module map | source-modules.mmd |
source-modules.svg |
| Menu / Play scenes | game-scenes.mmd |
game-scenes.svg |
| Save / load slots | save-load-flow.puml |
save-load-flow.svg |
| Core C++ types | core-runtime-classes.puml |
core-runtime-classes.svg |
| One sim substep (4 phases) | sim-margolus-step.mmd |
sim-margolus-step.svg |
| Brush input → GPU stamp | brush-input-flow.mmd |
brush-input-flow.svg |
| Docs home overview | home-overview.mmd |
home-overview.svg |
| Material reactions (overview) | material-reactions-overview.mmd |
material-reactions-overview.svg |
| Material reactions (full graph) | material-reactions.mmd |
material-reactions.svg |
| Lava + water quench | reaction-lava-water-quench.puml |
reaction-lava-water-quench.svg |
Narrative docs: ../ARCHITECTURE.md, ../DIAGRAMS.md, ../PHYSICS.md.
When to update¶
sim-pipeline.mmd,sim-margolus-step.mmd: sim/render pass wiring, compute backend, active-tile scissor rules.material-reactions.mmd,reaction-lava-water-quench.puml:shaders/sim.frag/sim_common.glslreaction branches.save-load-flow.puml:source/save/save.cppJSON fields or paths.game-scenes.mmd,brush-input-flow.mmd: menu flow, input mapping,PlayRegion.core-runtime-classes.puml,source-modules.mmd: new top-level modules or ownership changes.