rrt/README.md

47 lines
2 KiB
Markdown

Analysis and reimplementation of Railroad Tycoon 3.
## Overview
This repository supports two parallel tracks:
- reverse-engineering the 1.06 executable into durable atlases, exports, and capture notes
- building a headless Rust runtime that can rehost deterministic world work outside the shell
The canonical executable target is `rt3_wineprefix/drive_c/rt3/RT3.exe`.
## Workspace
- `crates/rrt-model`: shared schema, finance logic, and project-level constants
- `crates/rrt-runtime`: headless runtime state, importers, inspectors, stepping, and summaries
- `crates/rrt-fixtures`: fixture loading, normalization, validation, and diff helpers
- `crates/rrt-cli`: validation, runtime inspection, export, and comparison commands
- `crates/rrt-hook`: PE32 hook scaffold for capture and integration experiments
- `docs/`: stable handbook material, atlases, plans, and active queues
- `artifacts/exports/`: committed derived research outputs
- `artifacts/captures/`: committed raw logs, sample binaries, and retained capture evidence
- `fixtures/runtime/`: checked-in runtime fixtures
## Common Commands
- `cargo test --workspace`
- `cargo run -p rrt-cli -- validate .`
- `cargo run -p rrt-cli -- runtime summarize-fixture fixtures/runtime/minimal-world-step-smoke.json`
- `cargo run -p rrt-cli -- runtime inspect-smp <save.gms>`
- `tools/run_hook_smoke_test.sh`
## Docs
- [Handbook](docs/README.md)
- [Runtime Rehost Plan](docs/runtime-rehost-plan.md)
- [Active Rehost Queue](docs/rehost-queue.md)
- [Progress History](docs/history/progress-history.md)
- [Control-Loop Atlas Index](docs/control-loop-atlas/README.md)
- [Subsystem Views](docs/subsystem-views/README.md)
- [1.06 Export Index](artifacts/exports/rt3-1.06/README.md)
- [Capture Index](artifacts/captures/README.md)
## Notes
- `artifacts/tmp/` is scratch-only and should stay untracked.
- Canonical checked-in captures belong under `artifacts/captures/`.
- Detailed running status belongs in the docs and artifact indexes above, not in this root README.