Skip to content

Commit 28379a3

Browse files
authored
Update README.md
1 parent 5038201 commit 28379a3

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ Here's an example from [kOS](https://github.com/KSP-KOS/KOS/blob/22808556c090ebe
3939

4040
Note that `KSPCommon.targets` makes use of `KSPCommon.props` for advanced users, which sets all the below properties but does not include the build targets. If you only want the properties and not the targets, you can use `KSPCommon.props` instead.
4141

42+
### Customization
43+
44+
Properties can be customized at several points:
45+
46+
- Per-project properties should be set in the `.csproj` file before importing `KSPCommon.targets`
47+
- Per-mod properties for mods with more than one `.csproj` file should be set in `$(SolutionName).props` which will be imported by `KSPCommon.props`
48+
- Per-user properties should be set in `KSPCommon.props.user`. This is usually where you want to set the path to your KSP installation. You should have `.user` files added to your `.gitignore` file.
49+
4250
The following properties are exposed to be customized per mod, project, or user. Properties that represent directories should *not* include a trailing slash.
4351

4452
#### `RepoRootPath`
@@ -67,24 +75,17 @@ Default value: `1.12 1.11 1.10 1.9 1.8`
6775

6876
Used by the `CKANInstall` target to set additional KSP versions to treat as compatible when installing dependencies.
6977

70-
### Customization
71-
72-
Properties can be customized at several points:
73-
74-
- Per-project properties should be set in the `.csproj` file before importing `KSPCommon.targets`
75-
- Per-mod properties for mods with more than one `.csproj` file should be set in `$(SolutionName).props` which will be imported by `KSPCommon.props`
76-
- Per-user properties should be set in `KSPCommon.props.user`. This is usually where you want to set the path to your KSP installation. You should have `.user` files added to your `.gitignore` file.
77-
7878
### Referencing Dependencies
7979

80-
Referencing assemblies (DLLs) from other mods should be done with a HintPath relative to `$(KSPRoot)`. In addition, you can include the CKAN identifier of the mod to make it installable with the `CKANInstall` target.
80+
Referencing assemblies (DLLs) from other mods should be done with a HintPath relative to `$(KSPRoot)`. These should be placed *after* importing `KSPCommon.targets` so that `$(KSPRoot)` will be defined. In addition, you can include the CKAN identifier of the mod to make it installable with the `CKANInstall` target.
8181

8282
Example from [Shabby](https://github.com/KSPModdingLibs/Shabby/blob/e61ec5084b83c7e6941e62f43439cdd28fe867e6/Source/Shabby.csproj#L30):
8383

8484
```
85-
<Reference Include="0Harmony, Culture=neutral, PublicKeyToken=null">
85+
<Reference Include="0Harmony">
8686
<HintPath>$(KSPRoot)/GameData/000_Harmony/0Harmony.dll</HintPath>
8787
<CKANIdentifier>Harmony2</CKANIdentifier>
88+
<Private>false</Private>
8889
</Reference>
8990
```
9091

0 commit comments

Comments
 (0)