Getting Started
Requirements
Section titled “Requirements”- Python 3.11+
- Ollama (optional, for AI narration)
- xrpl-py (optional, for ledger backpack)
Install
Section titled “Install”pip install escape-the-valleyFor development or optional features:
# With dev toolspip install -e ".[dev]"
# With XRPL ledger backpackpip install -e ".[xrpl]"Play your first game
Section titled “Play your first game”The full-screen TUI is the recommended way to play:
trail tui --seed 42The --seed flag makes the run reproducible — same seed, same world, same events (given the same choices).
Other launch options
Section titled “Other launch options”# With AI narration (requires Ollama running locally)trail tui --seed 42 --voice
# With a specific Ollama modeltrail tui --seed 42 --model mistral
# Without AI narration (pure deterministic mode)trail tui --seed 42 --gm-off
# Resume a saved gametrail tui --continue
# Classic CLI mode (no full-screen TUI)trail new --seed 42trail playWhat you’ll see
Section titled “What you’ll see”The TUI shows your party status, supplies, wagon condition, and morale. Each turn you pick an action from camp: travel, rest, hunt, or repair. Events interrupt travel with choices (A/B/C). Towns offer safe harbor and trading.
Your goal: reach the valley exit before your supplies run out or your wagon breaks beyond repair.
Next steps
Section titled “Next steps”Read the Survival Guide for tips that will keep your party alive longer.