Skip to content

Commit 90963e1

Browse files
authored
docs: getting started
-add nuget instructions for older projects -add instructions on removing existing assembly references
1 parent 98cc1b9 commit 90963e1

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/msbuild/getting-started.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33

44
## Including the Package
5-
There are several ways to use the KSPBuildTools package in your mod. If you are using
6-
an [SDK-style csproj file](https://learn.microsoft.com/en-us/dotnet/core/project-sdk/overview), it is recommended to use NuGet
5+
There are several ways to use the KSPBuildTools package in your mod. [KSPBuildTools is available on NuGet](https://www.nuget.org/packages/KSPBuildTools), which is the recommended way to use it.
76

8-
### Install with NuGet
7+
### Install with NuGet - Older Framework Style projects
8+
9+
1. Right-click on your project file in Visual Studio and select "Manage NuGet Packages."
10+
2. Search for KSPBuildTools
11+
3. Optionally, check "Include prerelease" to get access to the bleeding edge of KSPBuildTools
12+
4. Click "Install"
13+
14+
### Install with NuGet - SDK Style projects
915

1016
either run the following command:
1117

@@ -51,6 +57,15 @@ Then include the targets file in your csproj. Make sure you use the correct path
5157

5258
Or you can copy the files you want into your own repository and use them however you like - though that will make it harder to get updates
5359

60+
### Remove existing assembly references
61+
62+
If you're adding KSPBuildTools to an existing mod, or if you just started a blank project, you likely have some assembly dependencies already in your csproj file. You need to remove these. KSPBuildTools will automatically reference the KSP, Unity, and Mono assemblies that are part of your KSP install. There are a few small differences between those Mono libraries and the regular .net framework ones.
63+
64+
1. Right-click on your project and select "Unload"
65+
2. Right-click again and select "edit"
66+
3. Remove ALL `<Reference>` items
67+
4. Right-click on your project and reload
68+
5469
## Locating your KSP Install
5570

5671
KSPBuildTools needs to know where you have KSP installed in order to reference the game dlls. These are all specific to your own computer, and should not be included in your git repo.

0 commit comments

Comments
 (0)