rimworld-mod-template/README.md

21 lines
1.3 KiB
Markdown
Raw Normal View History

2020-07-27 22:21:07 +02:00
# Rimworld Mod Template
2020-06-20 10:23:14 +02:00
2020-07-28 12:10:47 +02:00
This template is created for Rimworld moders who use [Visual Studio Code](https://code.visualstudio.com/) instead od Visual Studio IDE.
* __No virtual folders__. Easy to manage and edit both `xml` and `cs` files.
* __Lightweight__. Visual Studio Code only takes up to 200 MB of storage space and is lighting fast.
* __Automation__. Integrated build, scripting and management tools to perform common tasks making everyday workflows faster.
* __Customization__. Almost every feature can be changed, whenever it is editor UI, keybinds or folder structure.
2020-07-27 22:00:37 +02:00
2020-07-28 09:47:48 +02:00
## Setup
1. Download and install [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core) and [.Net Framework 4.7.2 Developer Pack]( https://dotnet.microsoft.com/download/dotnet-framework/net472). This step can be skipped if you already have C# packages from Visual Studio.
2020-07-27 22:00:37 +02:00
2. Instal [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp).
2020-07-28 11:20:43 +02:00
3. Clone or pull this template into your Rimworld `Mods` folder.
2020-07-28 12:10:47 +02:00
## Additional notes
By pressing `F5` key VS Code will perform 2 operations: build assembly file and launch Rimworld executable.
Modify `About.xml` and `Mod.csproj` files to match your mod name and version.
All C# intermediate files are kept in `.vscode/obj` folder.