Tools for developing mods for Kerbal Space Program
Get Started
$ dotnet add package KSPBuildToolsReadme
KSP Build Tools
This repository provides a common set of tools for developing mods for Kerbal Space Program. It integrates with MSBuild to simplify setting up plugins, and integrates with CKAN to easily reference other mods. it also includes a set of CI actions for automating builds.
Installation
Run dotnet add package KSPBuildTools on your project, or add
<ItemGroup>
<PackageReference Include="KSPBuildTools"/>
</ItemGroup>
to the .csproj file. Pinning the version is highly recommended.
Usage
Once you have a KSP installation to link to, all the game DLLs will be automatically included in your project automatically.
Configure your mod's location in GameData and where to put the output DLLs
<!-- DLLs will be written to ../GameData/ModName/Plugins/ -->
<KSPBT_ModRoot>$(MSBuildThisFileDirectory)/../GameData/$(MSBuildProjectName)</KSPBT_ModRoot>
<KSPBT_ModPluginFolder>plugins</KSPBT_ModPluginFolder>
Reference dependency mods in your DLL by adding ModReference items to the project. They will be automatically installed using CKAN.
<!-- Depends on Modulemanager and Harmony -->
<ItemGroup>
<ModReference Include="Modulemanager">
<DLLPath>GameData/Modulemanager*.dll</DLLPath>
<CKANIdentifier>ModuleManager</CKANIdentifier>
</ModReference>
<ModReference Include="0Harmony">
<DLLPath>GameData/000_Harmony/0Harmony.dll</DLLPath>
<CKANIdentifier>Harmony2</CKANIdentifier>
</ModReference>
</ItemGroup>