Skip to content

DEV_SETUP.md

Latest commit

 

History

History
27 lines (17 loc) · 1.52 KB

DEV_SETUP.md

File metadata and controls

27 lines (17 loc) · 1.52 KB

Setting up a developer environment

This mod uses the ZHMModSDK. Thus, the development process in general is fairly similar to other ZHMModSDK mods. There are however some additional steps needed due to the companion mod.

1. Clone this repository locally with all submodules.

You can either use git clone --recurse-submodules or run git submodule update --init --recursive after cloning.

2. Install Visual Studio (any edition).

Make sure you install the C++ and game development workloads.

3. Open the project in your IDE of choice.

See instructions for Visual Studio or CLion.

4. Setup Companion Mod

the mod utilizes a Simple Mod Framework companion mod to add custom assets and entity templates. while development is possible without it, it is highly recommended to set up the companion mod as well:

  1. install SMF into the SMF folder next to the game directory configured in the CMake project (e.g.: C:\Program Files (x86)\Steam\steamapps\common\Hitman 3\SMF).
  2. clone the companion mod repository into the mods folder (e.g.: C:\Program Files (x86)\Steam\steamapps\common\Hitman 3\SMF\Mods\).
  3. Re-configure the CMake project.
  4. The companion mod will automatically deploy when you build the chaos mod.