NotWorms

Tools

Required

• Unity 2021.3
• git
• csharpier
• Github Actions
• Git Hooks
• dotnet 5

Nice To Have

• rider
• cmder

Setup

0. Clone this repo
1. Install Unity Hub
   1. Install Unity 2021.3
2. Install the tools found in the manifest here
   1. dotnet tool restore
   2. dotnet husky install
3. Run git config --global core.autocrlf true
   1. This helps with the difference between windows and unix line endings (I think)
4. Add the unity tools directory https://docs.unity3d.com/Manual/SmartMerge.html to your path. We specifically want UnityYAMLMerge.exe available to git

Rider

General installation instructions can be found here https://csharpier.com/docs/Installation. A custom filewatcher can be setup in Rider that makes it so csharpier is ran on save.

To do that you can

1. Go to Settings > Tools > File Watcher
2. Hit the plus
3. Follow my setup here
4. Go to Editor > General > Typing Assist and disable Auto-format on semicolon and Auto-format on closing brace. This will help prevent rider for doing conflicting styling
5. Go to Tools > Actions on Save and disable Reformat and Cleanup code if it's enabled.

Best Practices

1. Make everything a prefab
2. Figure out other best practices