Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (17 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.4 KB

Setup your environment

1. Configure RimWorld Steam directory

Note

Required only if RimWorld isn't installed at the default path (C:\Program Files (x86)\Steam\steamapps)

Create a new Directory.Build.props.user file at the root of the repository. You can use Directory.Build.props.user.example as an example

2. Install dependencies

You will need Harmony installed.

In addition, you can install any/all the optional dependency mods you want to work with from ./AutomaticWorkAssignment/LoadFolders.xml

Dev process

Building

When compiling, the build process will try to copy the DLL in your RimWorld mods folder for 15s. You should either have the game closed when building, or restart it in that period. You can try out Reload mods to reopen the game in a click.

Formatting

Think about formatting your code with ./format.bat regularly.

./format.bat

In addition to this, you can run auto cleanups in Visual Studio with "Analyze" (in the very top of VS) > "Code Cleanup" > "Run Code Cleanup (Profile 1) on Solution". This can be configured to run automatically as described in this stackoverflow response