Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (42 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

53 lines (42 loc) · 1.88 KB

Contributing

Bug Reports

If you are reporting a bug please make sure to include KSP.log and/or Player.log along with your current mod list. For best results, follow the instructions at How to Get Support.

Installing Dependencies

HUDReplacer depends on HarmonyKSP. You will need to have it installed in the KSP instance you are building against.

Building

In order to build the mod you will need:

  • the dotnet CLI

Next, you will want to create a HUDReplacer.props.user file in the repository root, like this one:

<?xml version="1.0" encoding="UTF-8"?>

<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <ReferencePath>$KSP_ROOT_PATH</ReferencePath>
    </PropertyGroup>
</Project>

Make sure to replace $KSP_ROOT_PATH with the path to your KSP installation. If you have an install made via steam then you might be able to skip this step.

Finally, you can build by running either:

  • dotnet build (for a debug build), or,
  • dotnet build -c Release (for a release build)

This will create a GameData\HUDReplacer folder which you can then drop into your KSP install's GameData folder.

Linking the output into your GameData folder

If you're iterating on patches/code/whatever then you'll find that manually copying stuff into the GameData folder will get old really quickly. You can instead create a junction (on windows) or a symlink (on mac/linux) so that KSP will just look into the build artifact directory.

To do this you will need to run the following command in an admin cmd.exe prompt (for windows) in your GameData directory:

mklink /j HUDReplacer C:\path\to\HUDReplacer\repo\GameData\HUDReplacer

On Linux or MacOS you should be able to accomplish the same thing using ln.