HugsLib wiki

This wiki should help you get started with the library and highlight some common use cases for the available systems. Please let me know if you find any inconsistencies or would like additional reference material.

Wiki pages:

ModBase Reference: ModBase is the base class for all mods that want to use the facilities of the library. This is a good place to start.

Adding Mod Settings: Easily add custom settings to your mod for the player to modify.

Mod Update News: Notify the player about major changes to your mod.

Introduction to Patching: Hook into and modify and method in the game.

Custom Tick Scheduling: Schedule efficient logic updates for your Things.

Quickstarter: Automatically load or generate a map when the game starts.

Requiring a Minimum HugsLib Version: Safely use new library features.

Mod Spotter: Identify first-time players of your mod.

Update Notes

HugsLib 7.2 Update Notes

HugsLib 7.0 for Rimworld 1.1 update guide

HugsLib 9.0 for Rimworld 1.3 API Changes

Outdated material

World Data Storage (pre-1.0): A system to store mod data in a save file independently of individual maps.

Detouring (A16): Replace methods in the base game with your own. This system has been replaced by the Harmony library- see "Introduction to Patching" above on how to migrate your detours.

GUI Injection (A16): Add callbacks to the drawing method of any window in the game. This system has been replaced by patching- see the "Introduction to Patching" page above on how to convert existing injections to patches.