diff options
Diffstat (limited to 'dev_guide/README.md')
| -rw-r--r-- | dev_guide/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/dev_guide/README.md b/dev_guide/README.md new file mode 100644 index 0000000..996ce8a --- /dev/null +++ b/dev_guide/README.md @@ -0,0 +1,20 @@ +# About this directory + +These guides document **engine internals** for developers and code-assisting +agents: architecture decisions, durability contracts, presentation internals, +and per-game implementation notes. + +World-builder documentation (YAML content, room/object/mob/item guides, +casino table configuration) lives in [`../building_guide/`](../building_guide/README.md). +Do not add builder-facing content here, and do not add implementation notes, +TODOs or assessments to `building_guide/`. + +| Guide | Covers | +|---|---| +| [bank.md](bank.md) | Bank system session state and dispatch | +| [concurrency.md](concurrency.md) | Owner loop, durable money, lifecycle transactions, shutdown | +| [hacking.md](hacking.md) | Terminal objects and the hacking minigame interface | +| [pai_gow.md](pai_gow.md) | Pai Gow Poker hand evaluation, house way, settlement, Joker art | +| [roulette.md](roulette.md) | Roulette presentation internals and extension notes | +| [tick_order.md](tick_order.md) | The canonical per-tick system order (kept in sync with tests) | +| [video_poker.md](video_poker.md) | Video poker presentation and durable multiplier banks | |