HKBuildUtils 0.3.1

Hollow Knight Mod Build Utils

A nuget package to help make the Hollow Knight Mod

Features

Mods References Helper

Automatically download HKMAPI and other mods that depend on it when building.

How to use

Add the names of the mods you want to depend on to the <ItemGroup> in the following way

<ModReference Include="<Mod Name in ModLinks>" AssemblyName="[Assembly Name]" />

Among them, AssemblyName is optional, but due to the limitation of MSBuild, if the Mod assembly file name does not match its name on ModLinks, you need to fill in AssemblyName by yourself.

For example, Custom Knight, its assembly file name is CustomKnight.dll instead of Custom Knight.dll, therefore, it needs to be referenced as follows

<ModReference Include="Custom Knight" AssemblyName="CustomKnight" />

Set game path

Set game paths to use game files directly instead of downloading them again.

HKBuildUtils will look for the game directory in the following order (1.) The contents of hkpath.txt under the project folder or its ancestor folder (2.) HollowKnightRefs defined in the project file

Note:

1. (1.) will be used if both (1.) and (2.) are found, you can disable (1.) and use (2.) by using <DisableOverwriteHollowKnightRefs>true</DisableOverwriteHollowKnightRefs>
2. If neither of them exists or the directory they specify does not exist, it will be considered as a build in CI, and the dependent mods and HKMAPI will be downloaded to the ~ModLibrary folder under the project folder during the build

Merger with HKMirror

Use ILRepack to merge mods with HKMirror and eliminate unused types in HKMirror.

How to enable

Add <MergeHKMirror>true</MergeHKMirror> to PropertyGroup and reference HKMirror. The rest will take care of it for you.

Mod Resources

Using <ModResource></ModResource> instead of <EmbeddedResource></EmbeddedResource> automatically generates the type ModResources for use

Example

Add the following to the project file

<ItemGroup>
    <ModResource Include="Test1.txt"></ModResource>
    <ModResource Include="a/Test2.txt"></ModResource>
    <ModResource Include="b/c/Test3.txt"></ModResource>
</ItemGroup>

Then you can get them like this in your code

Modding.Logger.Log(ModResources.TEST1.Length);

Modding.Logger.Log(ModResources.TEST2.Length);

Modding.Logger.Log(ModResources.TEST3.Length);

You can add Default="true" to <ModResource> to use user-defined content.Like this

<ItemGroup>
    <ModResource Include="a/b/c" Default="true"></ModResource>
</ItemGroup>

You can get it through ModResources.C, just like mentioned above.

If ModResources.C is used, the file $(ModDir)/a/b/c is checked for existence first. If present, the file contents are returned, and if they are not, read from the assembly and written to the $(ModDir)/a/b/c file