ItemInspectionUI – Advanced Inspection Framework
ABOUT

ItemInspectionUI is a fully modular, extensible inspection system inspired by games like Escape from Tarkov — redesigned for Project Zomboid Build 42.

It provides a dedicated item inspection window with dynamic statistics, expanded descriptions, category-based modules, plugin support, adaptive layout, and automatic fallback when custom modules are not available.

The UI supports both Vanilla and Clean UI styles, with advanced resizing behavior designed to maintain full compatibility with Build 42’s UI restrictions.

MAIN FEATURES

• Dedicated item inspection window (sprite, stats, description).
• Adaptive statistics grid with 1–3 columns depending on window size.
• Modular description system (Modules/.lua) for category-specific logic.
• Extended category rules with Custom/ support.
• Plugin API allowing external mods to inject descriptors or overrides.
• Automatic detection of Clean UI vs Vanilla mode.
• Build 42–safe resize logic and robust UI behavior.
• Full compatibility with vanilla items and modded items.
• Universal fallback when no descriptor module matches the item.

ADVANCED RESIZE SYSTEM

The inspection window can be resized from the bottom-right corner.
A set of double-click actions is available (Build 42–safe):

• Double-click on resize area
→ Restore window to its original size.

• Shift + double-click
→ Activate Compact Mode (smaller window).

• Alt + double-click
→ Activate Wide Mode (larger, expanded layout).

NOTE:
Ctrl + double-click was intentionally disabled because Ctrl is used by the player for combat stance and would interfere with gameplay.

PLUGIN SUPPORT

The file:
shared/InspectSystem/Core/Inspect_Plugins.lua
provides an API for mods to register their own description modules or category rules.

Public function:
ItemInspection.RegisterPlugin(pluginTable)

Plugins can:
• Override category routing
• Provide additional description logic
• Modify the final text through postProcess()
• Integrate without modifying any base mod files

MOD STRUCTURE

media/lua/client/InspectUI → Main UI logic
media/lua/client/InspectUI/Context → Context menu + patches
media/lua/shared/InspectSystem/Core → Framework core logic
media/lua/shared/InspectSystem/Modules → Category-based description modules
media/lua/shared/Translate → EN / ES translations
textures/ui/InspectStats → Stat icons (to be added later)

COMPATIBILITY

✔ Build 42
✔ Clean UI
✔ Multiplayer safe
✔ Compatible with major mods (Hydrocraft, Brita, etc.)
✔ Server-friendly (no overrides of vanilla files)
✔ Lightweight and optimized for fast load times

LIMITATIONS

• Project Zomboid does not allow text or overlays to be rendered on top of a collapsed ISCollapsableWindow header.
• Because of this engine limitation, header tooltips in collapsed mode were removed.
• Collapsed mode will show only the icon and the "+" button.

CREDITS

Mod author, architecture and UI design: DarylMasterGG
Technical engineering, system assistance and documentation: ChatGPT

CONTACT

For bug reports, suggestions or feedback, please use the Steam Workshop page or your usual development environment.

End of README.txt