Git Product home page Git Product logo

zhmmodsdk's Introduction

ZHM Mod SDK

A modding SDK and mod loader for HITMAN 3.

build status

Description

This is a community-made modding SDK and mod loader for HITMAN 3. Its purpose is to allow users to easily download and use mods, and make the creation of more complex runtime mods easier for developers.

Right now it's at a very early stage, with only a few aspects of the engine exposed, but the plan is to further extend it to support basic entity, AI, and item manipulation.

Usage (mod loader & mods)

  1. Download the latest version of the mod loader and the mods by going here, and downloading ZHMModSDK-Release.zip. This zip file contains the mod loader and a few sample mods.

  2. Extract the contents of the ZHMModSDK-Release.zip archive to <drive>:\Path\To\HITMAN3\Retail, where <drive>:\Path\To\HITMAN3 is the path to your Hitman 3 installation directory. This will be at C:\Program Files\EpicGames\HITMAN3 or C:\Program Files (x86)\Steam\steamapps\common\HITMAN 3 by default. Make sure that you extract the files in the Retail folder and not the root HITMAN3 folder.

  3. Run the game like you normally would.

  4. When the game opens, you'll see a dialog asking you which mods you'd like to use. Select them and press OK. You might need to restart your game for some of them to work.

  5. Open the SDK panel with the ~ key (^ on QWERTZ layouts) to change loaded mods at runtime and to use the menus of certain mods.

  6. ...

  7. Profit?

NOTE: Some mods might require additional setup. For mods bundled with the SDK, refer to the table below. For any other mod, make sure to consult its installation instructions.

NOTE: You can at any time change the mods you're using by pressing the ~ key (^ on QWERTZ layouts) and selecting them, or by editing the mods.ini file inside your game's Retail folder.

NOTE: If you are trying to use this on a Steam Deck or under Proton / Linux, you might need to follow these additional steps.

Sample mods

There are a few sample mods included in this repository that can be used either as reference or for regular gameplay.

Mod name Description
NoPause Prevents the game from automatically pausing after losing focus (eg. when alt-tabbing or minimizing).
SkipIntro Skips the intro sequence and starts the game directly at the main menu.
WakingUpNpcs Makes pacified NPCs wake up after a random interval between 4 and 8 minutes.
CertPinBypass Disables SSL certificate pinning, allowing the game to connect to any trusted server instead of only IOI's.
MaxPatchLevel Dynamically sets the RPKG patchlevel to 1000, making the game discover patch chunks without having to modify the packagedefinition.txt file.
DebugMod Adds a debug menu to test different SDK functionalities, like 3D rendering and entity information display.
FreeCam Adds support for an in-game free camera that works with both KB+M and controllers. Can be toggled either from the SDK menu or by pressing P. For more details on available controls see here.
DiscordRichPresence Sends rich presence updates to Discord with details such as level name, gamemode, etc. Requires additional setup!
Editor A WIP in-engine "editor". Currently supports viewing spawned entities alongside basic lookup and manipulation. Requires additional setup!
Clumsy Makes 47 very clumsy. He just can't seem to figure out how to take cover... Requires additional setup!

Usage (for developers)

To find out how to create your own mods or how to extend the SDK, check out the wiki. Here are some guides to get you started:

Making mods with the SDK

Building & debugging the SDK

You can also check out the sample mods for reference.

Contributing

If you'd like to contribute to the SDK, feel free to open a pull request or an issue. If you're not sure where to start, check out the issues tab.

zhmmodsdk's People

Contributors

orfeasz avatar mike-koch avatar pavledev avatar andrewpratt64 avatar toastie avatar notexe avatar grappigegovert avatar theboxybear avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.