Skip to content

Commit f39d92f

Browse files
committed
Reorder some things
1 parent 825588f commit f39d92f

File tree

2 files changed

+9
-35
lines changed

2 files changed

+9
-35
lines changed

docs/msbuild/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuration
1+
# Configuration Reference
22

33
## Properties
44

docs/msbuild/getting-started.md

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@ There are several ways to use the KSPBuildTools package in your mod. [KSPBuildT
66

77
A detailed walkthrough for creating a new mod project using KSPBuildTools can be found [here](https://github.com/KSPModdingLibs/KSPModdingWiki/wiki/Creating-a-new-Plugin-Mod).
88

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

1811
either run the following command:
@@ -33,6 +26,13 @@ or add the following to your csproj:
3326
```
3427
````
3528

29+
### Install with NuGet - Older Framework Style projects
30+
31+
1. Right-click on your project file in Visual Studio and select "Manage NuGet Packages."
32+
2. Search for KSPBuildTools
33+
3. Optionally, check "Include prerelease" to get access to the bleeding edge of KSPBuildTools
34+
4. Click "Install"
35+
3636
### Including the Targets File Directly
3737

3838
If you aren't able to use the NuGet option, you can include the targets file directly using a git submodule.
@@ -61,37 +61,11 @@ Then include the targets file in your csproj. Make sure you use the correct path
6161

6262
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
6363

64-
### Remove existing assembly references
64+
## Remove existing assembly references
6565

6666
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.
6767

6868
1. Right-click on your project and select "Unload"
6969
2. Right-click again and select "edit"
7070
3. Remove ALL `<Reference>` items
7171
4. Right-click on your project and reload
72-
73-
## Locating your KSP Install
74-
75-
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.
76-
77-
There are several options for this. KSPBuildTools will choose in the following order. Either [autodiscovery in the solution directory](#solution-directory) or [setting a reference path in a .user file](#environment-variable) are the recommended methods for most users.
78-
79-
### KSPBT_GameRoot MSBuild Property
80-
81-
If the {confval}`KSPBT_GameRoot` MSBuild property is already set, KSPBuildTools will use it as-is. This can be set in your .csproj.user file.
82-
83-
### Environment Variable
84-
85-
Set the {envvar}`KSP_ROOT` environment variable to the root of a KSP install. This is useful for CI workflows such as those using the {gha:action}`compile` action.
86-
87-
### Solution Directory
88-
89-
KSPBuildTools will look for a "KSP" directory in your solution directory and use it if it is a valid install. It identifies valid installs by looking for `assembly-csharp.dll` in the appropriate subdirectory for your operating system.
90-
91-
### Reference Path
92-
93-
KSPBuildTools will use the `ReferencePath` MSBuild property if it is a valid KSP install. This can be set in a user file located at `{csproj path}.user`. If you use Visual Studio, it can generate this file and property for you.
94-
95-
### From Steam
96-
97-
KSPBuildTools will use the default Steam install location if it is a valid install

0 commit comments

Comments
 (0)