Installing & Building UrbanDevKit - CitiesSkylinesModding/UrbanDevKit GitHub Wiki

Installation

  • Standard CS2 modding toolchain;
  • Bun as the package manager and partial replacement for Node in the build toolchain.
  • Recommended: enable --developerMode --uiDeveloperMode as game launch options.

Here's an example of game launch command that also skips the launcher in Steam:

"C:\Program Files (x86)\Steam\steamapps\common\Cities Skylines II\Cities2.exe" %command% --developerMode --uiDeveloperMode

Building

In development:

  • For the UI part: Run bun dev to watch for changes in JSDevKit and the two test mods.
  • For the .NET part: Hit Build in your favorite IDE. This will also build the test mods, but a current limitation is that the JSDevKit should be built before, be it with bun dev:jsdevkit or bun build:jsdevkit.

For a complete build:

  • Run bun build to build everything UI-related. Unlike bun dev:*, this will also run the Biome linter and type checking.
  • Hit Build in your favorite IDE for the .NET part.