Compatibility

Frameworks

Framework	Status	Notes
QBX Core (Qbox)	✅ Native	Default. Detected automatically by the bridge.
QB-Core	✅ Native	Force with Config.Framework = 'qb' if auto-detect picks wrong.
ESX (es_extended)	✅ Native	Force with Config.Framework = 'esx'.

Config.Framework = 'auto' resolves at boot in priority order: qbx_core → qb-core → es_extended. Enable Config.DebugBridge to print what it detected.

Inventory

• Required: ox_inventory
• Item names are set in config/items.lua (soap / deodorant / perfume) and config/dental.lua (gum items). The toothbrush item is toothbrush_paste.
• All referenced items must exist in ox_inventory/data/items.lua.

HUD

Mode	Requirement
useCustomPanel = true	None — the built-in standalone HUD is used. No qbx_hud needed.
useCustomPanel = false	qbx_hud (or a HUD listening to hud:client:UpdateHygiene / hud:client:UpdateDental).

The built-in HUD design is inspired by qbx_hud (hexagon + liquid wave + holographic shimmer) and uses standard CSS/SVG that works inside FiveM's CEF.

Other dependencies

Resource	Used for
ox_lib	Notifications, progress bars, commands
ox_target	Shower prop interaction (when Config.Shower.useTarget = true)
dpclothing	Clothing-removal animations during showers
oxmysql	Persistence (player_hygiene, player_dental)

Housing

Config.Shower.requireHouse = true expects the player to be inside a house/shell. The bundled prop list includes props from common housing/furniture packs (origen_housing tubs, CU/DC/M25 shower heads, etc.). Props listed in Config.PublicShowerProps (e.g. the prison communal shower) bypass the house check.

Other suty resources

Resource	Interaction
suty-emotes	Shares the bzzz_cosmetics_bubble_a shower-bubble prop — no conflict
All other suty-	No conflicts

Known incompatibilities

None reported. Open a ticket on Discord if you find one.