Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes #238

pavledev · 2025-12-13T11:25:59Z

New Features

Added UTF-8 text rendering support for 3D text.
Implemented full actor inventory management in the Actors menu:
- Display inventory items
- Add and remove items
- Select main weapon
Introduced editor-style freecam setting with persistent checkbox state.
Added new item-related structures and types:
- SItemConfig
- Extended ZItemConfigDescriptor
- New ZHM5ItemWeapon class

Editor & UI Improvements

Menus (Items, Actors, Debug Channels) are now independent of editor window visibility.
Improved alignment and layout consistency across multiple UI sections.
Enhanced InputWithAutocomplete:
- Uses type registry directly
- Supports optional filter callbacks
- Updated documentation
Actor selection UX improvements:
- Automatic scrolling to selected actor
- Contextual selection button in Entity Properties
Reorganized and clarified CharSet Character Type controls.

Refactoring & Cleanup

Refactored actor-related naming (NPC -> Actor) and internal fields.
Replaced std::vector with std::unordered_set for m_PendingDynamicEntities
and ensured proper cleanup when entities are deleted.
Removed redundant prefixes and unused variables.
Improved const-correctness and API clarity:
- ZEntityImpl::GetID marked const
- ZDynamicObject::ToString now takes a reference parameter

SDK / Engine-Level Changes

Added Unicode-aware string handling and diacritic-insensitive search.
Included missing headers and fixed dependency ordering.
Adjusted virtual destructors where required for correctness.

…nd rename it to result

…entation

…llback

…indow visibility

… menus to prevent game crashes

…tead and remove unnecessary std::string conversion and compare ZString keys directly

…y-based actor names

…tfit

…stent alignment

…ame and s_ButtonId to s_ActorSelectableId

…torById

… search input above the list

…use in game and remove s_SelectedID

…s menu when an actor entity or its sub-entity is selected

…ng and selection and move CharSet Character Type combobox above the autocomplete input

…utfit” button, change its ID to ##CharSetCharacterType3, switch to s_CurrentCharSetCharacterType3, and remove m_GlobalOutfitKit checks from the ##CharSetCharacterType2 and ##CharSetCharacterType3 comboboxes

thecatontheceiling · 2026-01-01T08:50:27Z

when merge :RoccoSmile:

…e resource ID

Copilot

Pull request overview

This pull request introduces significant enhancements to the ZHM Mod SDK and Editor, focusing on Unicode text rendering support, actor inventory management, and new features for outfit and item randomization. The changes include refactored internal APIs, new SDK functions for resource management, and comprehensive UI improvements.

Key Changes:

Added UTF-8 text rendering support for both 2D ImGui and 3D in-game text with expanded character ranges
Implemented actor inventory management system with full item CRUD operations
Introduced new mods: Randomizer (item/weapon randomization) and Outfits (dynamic outfit loading from other scenes)
Enhanced Editor with rooms menu, improved property editors with copy-to-clipboard functionality, and actor inventory management
Refactored hook signatures (OnLoadScene now returns bool instead of void) and internal data structures

Reviewed changes

Copilot reviewed 81 out of 82 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ZHMModSDK/Src/ResourceLoading.cpp	Adds UnmountChunk function for unmounting resource packages with optional remounting
ZHMModSDK/Src/Rendering/Renderers/ImGuiRenderer.cpp	Extends font Unicode ranges to include Latin-1 Supplement and punctuation
ZHMModSDK/Src/Rendering/Renderers/DirectXTKRenderer.cpp	Refactors 3D text rendering to support UTF-8 encoding with improved code clarity
ZHMModSDK/Src/ModSDK.h/cpp	Changes OnLoadScene hook return type from void to bool
ZHMModSDK/Src/Hooks.cpp/h	Adds new hooks for scene creation, level management, inventory, and item spawning
ZHMModSDK/Src/Globals.cpp/h	Adds global pointers for TargetManager, RoomManager, UIMapTrackerManager, ContractsManager
ZHMModSDK/Include/Util/StringUtils.h	Implements UTF-8 string utilities with diacritic-insensitive search
ZHMModSDK/Include/Util/ResourceUtils.h	Adds chunk index parsing from resource package paths
ZHMModSDK/Include/Util/ImGuiUtils.h	Enhances InputWithAutocomplete with optional filter callback support
ZHMModSDK/Include/Glacier/*	Adds new entity classes and structures for items, rooms, outfits, and inventory
Mods/Randomizer/*	New mod for randomizing items and weapons in world, stash, player, and actor inventories
Mods/Outfits/*	New mod for loading outfit bricks from other scenes with chunk management
Mods/Player/Src/Player.cpp	Improves outfit selection UI with autocomplete and better error handling
Mods/Editor/Src/*	Adds rooms menu, inventory management, copy-to-clipboard for properties, and actor selection improvements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

OrfeasZ

Some initial notes from a quick run through. I haven't looked at everything yet, so more to come once you've added the rest of your changes.

OrfeasZ · 2026-01-03T16:18:28Z

Mods/DiscordRichPresence/Src/DiscordRichPresence.cpp

+        Globals::ResourceManager->LoadResource(s_JsonResourcePtr, s_JsonReferenceInfo.rid);
+
+        if (!s_JsonReferenceInfo.resourceData) {
+            Logger::Error("{:016x} JSON resource isn't installed!", s_JsonReferenceInfo.rid.GetID());


Under what cases would this happen? Could we call something like ResourceManager::Update to get it to load?

I don't think it could happen. That check can be removed

OrfeasZ · 2026-01-03T16:20:57Z

Mods/DiscordRichPresence/Src/DiscordRichPresence.cpp

+            s_CodeNameHint = s_CodeNameHint.substr(s_CodeNameHint.find_last_of("/") + 1);
+        }
+
+        s_Location = m_CodeNameHintToSceneName[s_CodeNameHint];


What if s_CodeNameHint doesn't exist in the map?

I will change it to use iterator and set ERR_UNKNOWN_LOCATION if s_CodeNameHint doesn't exist in map

OrfeasZ · 2026-01-03T16:31:59Z

Mods/SkipIntro/Src/SkipIntro.cpp

+    p_Hook->CallOriginal(th, result);

-    for (auto& s_Brick : p_parameters.m_aAdditionalBrickResources)
-        Logger::Debug("+ With brick: {}", s_Brick);
+    if (result == "assembly:/_PRO/Scenes/Frontend/Boot.entity") {
+        result = "assembly:/_PRO/Scenes/Frontend/MainMenu.entity";
+    }

-    if (p_parameters.m_SceneResource == "assembly:/_PRO/Scenes/Frontend/Boot.entity")
-        p_parameters.m_SceneResource = "assembly:/_PRO/Scenes/Frontend/MainMenu.entity";
-
-    return HookResult<void>(HookAction::Continue());
+    return HookResult<ZString*>(HookAction::Return(), &result);


A side-effect of this change is that if this mod is enabled, no other mod will be able to use the ZEngineAppCommon_GetBootScene hook (depending on load order), since it calls the original function and returns. That's not necessarily a bad thing, but something to note.

OrfeasZ · 2026-01-03T16:35:59Z

ZHMModSDK/Include/Util/ResourceUtils.h

+namespace Util {
+    class ResourceUtils {
+    public:
+        static bool TryParseChunkIndexFromResourcePackagePath(const ZString& s_ResourcePackagePath, uint32_t& p_OutChunkIndex) {


These could use some comments to explain what the difference between the two functions is (an example of what to call them with would be helpful too). Could also return an std::optional<uint32_t> instead of using an out parameter.

OrfeasZ · 2026-01-03T16:39:19Z

ZHMModSDK/Src/Glacier/ZPrimitives.cpp

@@ -0,0 +1,3 @@
+#include "Glacier/ZPrimitives.h"
+
+const ZGuid ZGuid::Empty {};


Couldn't this be inline?

I get error "incomplete type "const ZGuid" is not allowed" if I declare it as inline in ZGuid

…ap in Rooms menu

…inal

…esToRuntimeResourceIds

…et_Camera_Tagging

pavledev added 30 commits December 7, 2025 18:41

Add const qualifier to ZEntityImpl::GetID method

5013ed9

Change ZDynamicObject::ToString parameter from ZString* to ZString& a…

ac21339

…nd rename it to result

Add filter callback support to InputWithAutocomplete and update docum…

2eaa9d2

…entation

Use type registry directly in InputWithAutocomplete and add filter ca…

0c22568

…llback

Show Items, Actors and Debug Channels menus independently of editor w…

c80d53c

…indow visibility

Add support for UTF-8 3D text rendering

657ea69

Fix formatting of a lambda parameter in InputWithAutocomplete call

e94f799

Reformat lambda parameter in InputWithAutocomplete call

be0e573

Filter out outfits where m_bIsHitmanSuit is true in Actors and Assets…

fc322d7

… menus to prevent game crashes

Add IsEmpty method to ZString

85fa08e

Remove ConvertDynamicObjectValueToString and use ZObjectRef::As<> ins…

b8b97c6

…tead and remove unnecessary std::string conversion and compare ZString keys directly

Add Unicode text support, diacritic-insensitive search, and repositor…

04b71e6

…y-based actor names

Refactor Assets::EquipOutfit, Editor::EquipOutfit and Player::EquipOu…

c8388cd

…tfit

Replace ImGui::Text("") with ImGui::Spacing()

1db9b37

Add ImGui::AlignTextToFramePadding() in several UI sections for consi…

b6e131f

…stent alignment

Reformat lambda parameter in InputWithAutocomplete call in Player mod

1de2d35

Rename s_ActorName to s_ActorName2, s_ActorName_Substring to s_ActorN…

2f5b6bb

…ame and s_ButtonId to s_ActorSelectableId

Rename NPC to Actor in several UI elements and variables

c3f126b

Add new fields to ZActorManager and refactor GetActorByName and GetAc…

c2e1cc3

…torById

Fix missing usage after renaming m_aActiveActors to m_activatedActors

0fb4ff4

Remove s_ContentKitManager and use Globals::ContentKitManager instead

c9cbd5f

Remove unused ZEntityRef variable in DrawActors

2e3a3fd

Add “Show only alive actors” and “Show only targets” filters and move…

543ae5b

… search input above the list

Automatically scroll the actor list to the actor selected with the mo…

ea9a730

…use in game and remove s_SelectedID

Remove redundant empty line in Editor::DrawEntityProperties

20bdbce

Add button in Entity Properties menu to select the actor in the Actor…

a51631e

…s menu when an actor entity or its sub-entity is selected

Fix remaining m_aActiveActors -> m_activatedActors usage

83c211f

Use InputWithAutocomplete instead of InputText for actor name filteri…

e5d141d

…ng and selection and move CharSet Character Type combobox above the autocomplete input

Rename m_CurrentlySelectedActor to m_SelectedActor in Editor mod

dffd461

pavledev added 9 commits January 1, 2026 12:01

Remove setting before erasing item from list

d38034f

Allow spawning non-repository props using both resource ID and runtim…

f6fe92b

…e resource ID

Update README mod descriptions

226a0cf

Rename s_EntityTreeNode to s_Iterator in Editor::EntityRefProperty

1875c67

Add copy buttons for remaining property types except ZString and bool

51818c8

Move entity name search above type name search

3d06d72

Rename LoadPropsFromSettings to LoadPropsToSpawnFromSettings

6374c4c

Fix call after renaming LoadPropsToSpawnFromSettings

401b6d0

Add LoadPropsToExcludeFromSettings

1fc1e21

pavledev changed the title ~~Editor and SDK Improvements: Unicode Text, Actor Inventory, UI Refinements and Crash Fixes~~ Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes Jan 3, 2026

OrfeasZ requested a review from Copilot January 3, 2026 16:03

Copilot started reviewing on behalf of OrfeasZ January 3, 2026 16:03 View session

Copilot AI reviewed Jan 3, 2026

View reviewed changes

OrfeasZ requested changes Jan 3, 2026

View reviewed changes

pavledev added 15 commits January 3, 2026 18:58

Fix UTF-8 text iteration and glyph counting in DrawText3D

a8a4a6a

Guard main weapon assignment with inventory size check

7632020

Use iterator instead of operator[] when accessing m_CachedEntityTreeM…

5da18f9

…ap in Rooms menu

Use GetOption to retrieve boot scene path instead of calling CallOrig…

e26b995

…inal

Remove unnecessary JSON resource data check

910d74d

Use iterator lookup and fallback for scene codename mapping

5ccc69e

Rename p_OutfitsBrickRuntimeResourceId to p_OutfitBrickRuntimeResourceId

bcb376a

Remove unused variable s_SelectedIndex

4b92269

Remove unnecessary JSON resource data check in Outfits::BuildSceneNam…

e59531c

…esToRuntimeResourceIds

Add m_HitmanPFLocation field to ZHM5GridManager

e7ea847

Add AreaHandle::GetAreaUsageFlags function

b5a368a

Replace character index access with ECharSetCharacterType enum values

91ed358

Fix category setting lookup by lowercasing inventory category

a2a2783

Use lowercase category names when writing category settings

336efa2

Change INI format for stored props and exclude Gadget_Camera and Gadg…

470de40

…et_Camera_Tagging

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes #238

Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes #238

Uh oh!

pavledev commented Dec 13, 2025

Uh oh!

thecatontheceiling commented Jan 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

OrfeasZ left a comment

Uh oh!

OrfeasZ Jan 3, 2026

Uh oh!

pavledev Jan 3, 2026

Uh oh!

OrfeasZ Jan 3, 2026

Uh oh!

pavledev Jan 3, 2026

Uh oh!

OrfeasZ Jan 3, 2026

Uh oh!

OrfeasZ Jan 3, 2026

Uh oh!

OrfeasZ Jan 3, 2026

Uh oh!

pavledev Jan 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,3 @@
		#include "Glacier/ZPrimitives.h"

		const ZGuid ZGuid::Empty {}; No newline at end of file

Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes #238

Are you sure you want to change the base?

Editor and SDK Update: Unicode Text, Actor Inventory, Rooms, Outfits, Randomizer, UI Refinements, and Crash Fixes #238

Uh oh!

Conversation

pavledev commented Dec 13, 2025

New Features

Editor & UI Improvements

Refactoring & Cleanup

SDK / Engine-Level Changes

Uh oh!

thecatontheceiling commented Jan 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

OrfeasZ left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants