Guides
Step-by-step tutorials for common modding tasks
These guides walk you through complete modding scenarios, from start to finish.
Available Guides#
Custom Cities#
Learn how to add your own cities with custom maps, demand data, and buildings. Covers:
- Data file generation
- Tile server setup
- Routing service configuration
- Validation and testing
UI Components#
Build custom user interfaces for your mod:
- Settings panels
- Floating windows
- Toolbar buttons
- Custom React components
Data Visualization#
Create charts and dashboards using Recharts:
- Pie charts for mode share
- Line charts for ridership trends
- Bar charts for station comparisons
- Real-time updating displays
Tips for Success#
- Start Small - Begin with simple mods and gradually add complexity
- Test Often - Use hot reload to test changes quickly
- Read the Console - The modding API logs operations with
[Modding API]prefix - Check Examples - Look at the test-mods/ folder in the game repo
Community Resources#
- Discord: Join the #modding channel for help and sharing
- GitHub: Submit popular mods as PRs to be included officially
- Wiki: Community-maintained documentation and examples
Frequently Requested Mods#
The community frequently requests:
- European cities (Berlin, Paris, Madrid)
- Canadian cities (Toronto, Montreal, Vancouver)
- Custom map styles (vintage, dark mode, colorful)
- Game rule modifications (harder/easier modes)
These are prime targets for your first mod!