ZenKitCS

A C#-library wrapping the ZenKit library for parsing game assets of PiranhaBytes' early 2000's games Gothic and Gothic II.

Using

You can install ZenKitCS from the NuGet Package Gallery. Simply add the following snippet to your .csproj file, replacing the version with the approprite version identifier from NuGet.

<ItemGroup>
  <PackageReference Include="ZenKit" Version="x.x.x" />
</ItemGroup>

To build your project then, you will need to add a RuntimeIdentifiers property to your .csproj. You can simply use this once and copy it the topmost <PropertyGroup> in your .csproj like this:

<PropertyGroup>
    <!-- ... -->
    
    <RuntimeIdentifiers>linux-x64;win-x64;osx-x64;android-arm64</RuntimeIdentifiers>

    <!-- ... -->
</PropertyGroup>

You can now also build your project for those runtimes by supplying the runtime identifier in dotnet build using the -r parameter. This is how you would build your project for Android:

dotnet build -r android-arm64 -c Release --self-contained

Building

You will need:

.NET Standard 2.1 (for ZenKit itself) and .NET 7 (for ZenKit.Tests), anything onward should work as well
Git

To build ZenKitCS from scratch, just open a terminal in a directory of your choice and run

git clone --recursive https://github.com/GothicKit/ZenKitCS
cd ZenKitCS
dotnet build

You will find the built library in ZenKit/bin/Debug/netstandard2.1.

Testing

To test ZenKitCS, just run dotnet test in the Git folder or in the ZenKit.Test project.