FrontmatterVersion	DocumentType	Title	Summary	Created	Updated	Owners	References
1	Guide	CS2 Modding Guide README	Orientation and index for the Vice & Order CS2 modding guide, curated from official docs, community research, and decomp studies.	2025-11-20	2025-11-20	codex	Label Path Workspace README ../../README.md Label Path Workspace AGENTS ../../AGENTS.md Label Path Workspace Guide ../../WORKSPACE_GUIDE.md Label Path Instruction Documents Bootstrap ../../.guide/prompts/common/getting-started/01_InstructionDocumentsBootstrap.md Label Path Projects README ../README.md Label Path Projects AGENTS ../AGENTS.md Label Path Projects GUIDE ../GUIDE.md Label Path CS2 Modding Guide Agents ./Agents.md

Vice & Order CS2 Modding Guide

Welcome to the working playbook for building and maintaining the Vice & Order mod ecosystem. Everything here is curated from official Cities: Skylines II documentation, community research, and lessons learned from dissected mods such as Realistic Path Finding, Achievement Fixer, and Time2Work.

Start Here

• Agents - orientation for automation assistants and newcomers.
• Setup Overview - launch profiles, toolchain installation, project bootstrap, and publishing routines.
• Architecture Overview - module lifecycle, dependency checks, shared terminology, and API contracts.
• Simulation Overview - patterns for replacing vanilla systems, templates, diagnostics, and testing.
• Operations Overview - logging, debugging, release management, automation, and incident response.
• UI Overview - Options UI patterns, key bindings, runtime panels, and React guidance.
• Patterns Overview - reusable code snippets for common module constructs.

Setup

• Launch Profiles and Developer Flags
• Toolchain Installation
• Bootstrap a Code Mod
• Bootstrap a UI Project
• Build and Publish Workflow
• Environment Health Checks

Architecture

• Module Layout
• Lifecycle and Initialization
• Settings and Data Management
• System Scheduling
• Dependency Strategy
• Performance Targets and Terminology

Simulation

• Overview
• Replacing Vanilla Systems
• System Template
• Multi-Phase Scheduling
• Conditional Execution and Diagnostics
• Testing and Recovery

UI and Interaction

• Options UI Patterns
• Key Binding Pipeline
• Runtime UI Panels
• Dependency Handling
• UI Testing Checklist
• React Pipeline Overview and supporting pages
• Options Attribute Reference
• Unified Icon Library
• I18n Everywhere Integration

Content and Assets

• Overview
• PBR Asset Workflow
• Editor Integration
• Map and Scenario Authoring
• Support and Publishing
• Unofficial Asset Import
• Write Everywhere Modules
• Asset Pack Management

Tooling Patterns

• Raycast Filters
• Sub-Element Removal
• Validation Overrides
• Transform Gizmos

Shared Dependencies

• Unified Icon Library
• I18n Everywhere Integration
• Shared Library: ExtraLib (optional)

Development Patterns

• Patterns Overview
• Mod Bootstrap
• Settings Patterns
• Localisation Helper
• System Registration

Operations

• Operations Overview
• Logging and Debugging
• Memory and Performance
• Security and Stability
• Release Checklist
• Automation and CI
• Incident Response

Case Studies

• Overview
• Realistic Path Finding
• Achievement Fixer
• Time2Work (Realistic Trips)
• Anarchy
• Better Bulldozer
• Extra Detailing Suite
• Localization & UI Infrastructure
• Write Everywhere Ecosystem
• Asset Packs Manager

Reference Material

• External Resources

Maintenance Notes

• Keep all files ASCII unless existing content requires otherwise.
• Update Agents and this index when major guidance changes.
• Reference mod IDs when documenting dependencies so automation can enforce publish requirements.

Use this repository as the authoritative source for CS2-related workflows inside Vice & Order. Contributions should prioritise actionable steps, code examples, and references to upstream documentation.