NavKit

A tool to generate Navp and Airg files for Hitman: World of Assassination Scenes in the Glacier 2 Engine

How to Use

The NavKit Guide is available on the Glacier Modding Wiki.

You can run NavKit by opening NavKit.exe. To use the View Navp in game and Scene Extraction features, you will need ZHMModSdk installed. For the Scene Extraction feature, you will also need to have Blender installed.

You will also need to install the latest Visual C++ Redistributable from https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-140. Make sure you get the X64 version.

Functions available are loading and saving Navp and Navp.json, loading Airg and Airg.json, loading and saving Obj, scene extraction, building Navp, building Airg and viewing navp in game.

Full generation of Navp and Airg (Scene Extraction, Navp generation, Airg generation)

1. Download the latest release of NavKit (https://github.com/glacier-modding/NavKit/releases/latest) and run the installer
2. Install ZHMModSDK (Usually you will want to use https://github.com/OrfeasZ/ZHMModSDK/releases/latest, but for NavKit version 2.4.0 you will want to use the SDK artifact from this build: https://github.com/dbierek/ZHMModSDK/actions/runs/20363060518)
3. Install Blender (tested with 3.4 and 4.3 https://download.blender.org/release/Blender4.3/)
4. Install the latest Visual C++ Redistributable from https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-140. Make sure you get the X64 version.
5. Start Hitman and enter a mission
6. Open NavKit
7. On the "Settings > NavKit" menu of NavKit, set your file paths:
   1. Hitman 3 directory (e.g., C:\Program Files (x86)\Steam\steamapps\common\HITMAN 3)
   2. Output directory (e.g., C:\NavKit\Output)
   3. Blender Executable (e.g. C:\Program Files\Blender Foundation\Blender 4.3\blender.exe)
8. On the "Extract menu" of NavKit, click the "Extract scene from game and build all" button. It may take up to around 10 minutes depending on the complexity of the mission being extracted, and whether the alocs have already been extracted from the rpkg files.
9. When the OBJ finishes generating, you can save it to an OBJ file so you can load it later if you'd like by clicking "File > Save Obj" on the menu bar
10. When the NAVP finishes generating, click on "File > Save Navp" on the menu bar
11. When the AIRG finishes generating, click on "File > Save Airg" on the menu bar

Adding navp and airg to a new scene

1. Include the .navp and .airg files in the chunk folder for your brick
2. Choose an IOI string for it (for instance, [assembly:/_pro/scenes/missions/trapped/scene_wolverine_modified.navp].pc_navp)
3. In GlacierKit, search the original scene file for "navp" and it should take you to the Pathfinder Configuration (usually at Scene\Scenario_[scene name]\Global\Pathfinder\PathfinderConfiguration
4. Copy the entity id (in this example screenshot it is 0f374e8c1e033807) and put it somewhere easily accessible
5. Open your new brick file in GlacierKit in the Editor
6. In the Property overrides for your new brick, add this to add the navp:

    {
        "entities": [
            {
                "ref": "[pathfinder entity id]",
                "externalScene": "[original scene file]"
            }
        ],
        "properties": {
                "m_NavpowerResourceID": {
                    "type": "ZRuntimeResourceID",
                    "value": {
                        "resource": "[new navp ioi string]",
                        "flag": "5F"
                    }
                }
        }
    }

7. Where [pathfinder entity id] is the id you copied earlier for the pathfinder, [original scene file] is the ioi string of the original scene (e.g. [assembly:/_pro/scenes/missions/snug/mission_vanilla.brick].pc_entitytype), and [new navp ioi string] is your new ioi string for the navp.
8. In GlacierKit, search the original scene file for "airg" and it should take you to the Pathfinder Configuration (usually at Scene\Scenario_[scene name]\Global\Pathfinder\ReasoningGridConfig
9. Copy the entity id (in the other example screenshot it is 6c6e6c3217bf058e) and put it somewhere easily accessible
10. In the Property overrides for your new brick, add this to add the airg:

    {
        "entities": [
            {
                "ref": "[reasoning grid entity id]",
                "externalScene": "[original scene file]"
            }
        ],
        "properties": {
                "m_pGrid": {
                    "type": "ZRuntimeResourceID",
                    "value": {
                        "resource": "[new airg ioi string]",
                        "flag": "5F"
                    }
                }
        }
    }

11. Where [reasoning grid entity id] is the id you copied earlier for the pathfinder, [original scene file] is the ioi string of the original scene (e.g. [assembly:/_pro/scenes/missions/snug/mission_vanilla.brick].pc_entitytype), and [new airg ioi string] is your new ioi string for the navp.
12. Save your brick file
13. In GlacierKit, under the Text Tools, paste your navp ioi string into the Hash Calculator
14. Copy the Hex value, and rename your navp to [hex value].navp Where [hex value] is the Hex value you calculated
15. Paste your airg ioi string into the Hash Calculator
16. Copy the Hex value, and rename your airg to [hex value].airg Where [hex value] is the Hex value you calculated
17. Deploy the mod

How NavKit generates Navp and Airg files

NavKit performs the following series of steps to be able to generate Navp files.

1. Connect to the Editor server of the running Hitman game, and issue commands to: rebuild the entity tree, find the scene's ZGeomEntities, PFBox entities, and PFSeedPoint entities and send their data back to NavKit, where they are saved to output.nav.json in the specified output folder.
2. Extract all the necessary Aloc or Prim files from the rpkg files to the aloc or prim folder of the specified output folder using glacier2obj.exe (A rust program included in the installer).
3. Open the blender cli and run the glacier2obj.py script to generate an obj by importing all the Aloc or Prim files, copy them the number if times they are used in the scene, and transform each one according to what was sent by the game, and save it to output.obj in the specified output folder.
4. Load output.obj from the specified output folder or another specified Obj file.
5. At this point, the build Navp section of the menu will be available, and you can customize the parameters with "Settings > Recast Settings" on the menu bar, then press "Build > Build Navp" on the menu bar to call Recast to generate the Navmesh. Then you can save the Navmesh as a Navp or Navp.json file by pressing the Save Navp button.
6. At this point, the build Airg section of the menu will be available, and you can customize the parameters, then press build to generate the Airg.

Disclaimer

NavKit is still a work in progress, and there may be glitches or issues with Obj, Navp, or Airg generation in the current version. If you encounter any problems while running NavKit please create an issue on this GitHub repo.

Future enhancements

• Faster Scene generation
• Linux and macOS support
• More issues on the Issues tab

Building instructions (CLion or Visual Studio)

1. Clone this repository with the '--recurse-submodules' option
2. Open in Visual Studio or CLion
3. Cmake should load
4. In the x64 command prompt make a build folder, cd into it, and run:
   cmake -B . -S ..
5. Then change back to the main directory and run
   cmake --preset x64-debug

MSI Building instructions

You shouldn't need to build the MSI yourself, but here are the instructions:

1. Install WiX 6.0 and add its bin/x64 folder to your PATH
2. Run the installer target. For CLion there is an included run configuration that should automatically be added called Build MSI that runs this command:
   cmake --build . --target installer --config Release
   in this working directory:
   build\x64-release

Building instructions (Rider)

See Rider Instructions

Credits

2kpr
Anthony Fuller
Atampy26
Dafitius
Dog
Dribbleondo
Invalid
IOI
Jojje
Kercyx
Kevin Rudd
LaNombre
Luka
Lyssa
NoFate
Notex
Pavle
Piepieonline
Rdil
Recast team
Someone Else
Voodoo Hillbilly
And everyone at the Glacier 2 discord!