rimworld-mod-template/README.md

23 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 14:04:18 +02:00
This template is created for Rimworld moders who use [Visual Studio Code](https://code.visualstudio.com/) instead of Visual Studio IDE.
2020-07-28 12:10:47 +02:00
* __No virtual folders__. Easy to manage and edit both `xml` and `cs` files.
2020-07-28 13:25:52 +02:00
2020-07-28 12:10:47 +02:00
* __Lightweight__. Visual Studio Code only takes up to 200 MB of storage space and is lighting fast.
2020-07-28 13:25:52 +02:00
* __Automated__. Integrated build, scripting and management tools to perform common tasks making everyday workflows faster.
* __Customizable__. 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
2020-07-28 13:50:11 +02:00
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 required C# packages from Visual Studio IDE.
2020-07-27 22:00:37 +02:00
2. Instal [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp).
2020-07-28 13:25:52 +02:00
3. Clone, pull or download this template into your Rimworld `Mods` folder.
2020-07-28 12:10:47 +02:00
## Additional notes
2020-07-28 13:25:52 +02:00
* By pressing `F5` key VS Code will perform 2 operations: build assembly file and launch Rimworld executable.
* All intermediate files are kept inside `.vscode` folder.
2020-09-11 16:06:16 +02:00
* Modify `.vscode/mod.csproj` and `About/About.xml` according to your needs.
2020-07-28 13:25:52 +02:00