How-To Guides
Task-oriented guides that help you accomplish specific goals. These assume you already understand the basics and need to solve a particular problem.
Note
Looking for tutorials? See Tutorials for learning-oriented guides that build foundational knowledge.
Extending the Simulation
Guides for extending and customizing the simulation mechanics.
- Add a Custom System
Create, register, and test custom simulation systems to model new mechanics like propaganda, sanctions, or environmental effects.
- Tune Simulation Parameters
Load, modify, and analyze
GameDefinesparameters. Includes parameter sweeps and sensitivity analysis workflows.
Debugging & Analysis
- Debug Simulation Outcomes
Diagnose unexpected results systematically. Use structured logging, trace analysis, and formula verification to identify issues.
- Analyze Parameter Sensitivity
Explore how parameter changes affect simulation outcomes. Run sweeps, identify thresholds, and validate theoretical predictions.
GUI Development
- GUI Development Plan
Build visualization and user interface features using NiceGUI. Covers the phased approach from basic displays to full interactivity.
Getting Started
- Set Up a Development Environment
Complete setup guide for Linux, macOS, and Windows. Windows users get step-by-step WSL 2 installation and VSCode Remote integration.
Contributing
- Submit a Pull Request
Complete workflow from branching to merge. Includes branch naming, commit conventions, and handling CI failures.
- Run CI Locally
Test CI checks before pushing using direct commands, mise tasks, or
gh actfor full workflow simulation.
Coming Soon
These guides are planned for future development:
Optimize RAG - Improve AI narrative generation performance
Build PDF Documentation - Generate PDF books from Sphinx docs