Overview
This modified version of ps-hud requires QBCore. The HUD (the information shown on screen) includes DrSnyder's vehicle dashboard, weapon and ammo display, money alerts, ox_fuel support, and harness checks through ox_inventory. It is not designed for Qbox on its own.
Requirements
- Framework
- QB-Core
- Fuel
- Native vehicle fuel level; compatible with ox_fuel
- Required script
- ox_inventory to check whether the player has an active harness
- UI
- Compiled Svelte interface included
- Resource name
- Must remain ps-hud
Installation
Place ps-hud in your designated resources folder without renaming it.
Ensure QB-Core is current and starts before ps-hud.
Review Config.UseMPH, Config.CustomHud, and Config.AdminOnly in config.lua.
Start ps-hud, then review the icon settings and vehicle behavior in-game.
Configuration
How the HUD reads fuel
This fork reads FiveM's native vehicle fuel level, which works with ox_fuel when it synchronizes that value. The inherited Config.FuelScript setting does not change the active fuel reader by itself.
Choose speed units
Config.UseMPH changes the speed calculation. Changing the displayed unit text also requires UI work; rebuilding from svelte-source is safer than editing the compiled interface directly.
Enable the added HUD modules
Review the vehicleName, weaponAmmo, and money options under Config.CustomHud, then decide whether customization should be restricted through AdminOnly.
Keep the included interface files
The html folder is ready to use. The svelte-source folder is only for changing the interface and does not need to be rebuilt for a normal installation.
How to use and test it
First-run checklist
Join after the framework and HUD have started, enter a vehicle, equip a weapon, change cash or bank values, and verify the player, vehicle, weapon, and money displays independently.
/menu
/resethudPreserve optional audio feedback
Start InteractSound before ps-hud if your configuration uses its menu, belt, or alert sounds.
Differences from upstream
- Framework
- QB-Core required
- Harness inventory
- ox_inventory runtime export
- UI source
- Compiled html plus editable svelte-source
- Fuel reading
- Native FiveM vehicle fuel level
Vehicle, weapon, and money displays
The drs_Dev fork rebuilds the vehicle cluster and adds weapon-ammunition plus cash and bank presentation while retaining the Project Sloth customization foundation.
OX-oriented runtime behavior
The active fuel path reads FiveM's native vehicle fuel level for ox_fuel compatibility, and harness detection calls ox_inventory directly.
Known limitations
This is not a native Qbox HUD
The manifest imports qb-core locale data and runtime code calls qb-core. Use a compatible QB exposure on Qbox only after validating every dependent path.
Some settings require UI work
Config.UseMPH changes the speed calculation, but the displayed unit text may still require rebuilding from svelte-source. Config.FuelScript does not select the active fuel reader.
Admin UI saves need a writable resource
The admin-only save path writes uiconfig.lua at runtime. Confirm the deployed resource directory permits the intended write or manage the file outside the game server.
Updating
Compare Project Sloth updates manually
Back up config, uiconfig, compiled html, and svelte-source before merging upstream work. Replacing the fork with an upstream archive removes the drs_Dev vehicle, weapon, money, and OX changes.
Troubleshooting
The HUD does not initialize
Keep the resource folder named ps-hud, update qb-core, and confirm qb-core starts before the HUD.
Harness detection is missing
Confirm ox_inventory is started and the harness item exists. This edition checks the item count through ox_inventory.
Fuel is not updating
Confirm the fuel resource starts before ps-hud and synchronizes FiveM's native vehicle fuel level. Config.FuelScript does not select the active reader in this fork.
Two HUD elements overlap
Disable the equivalent stock or third-party HUD element so only one resource owns each vehicle, weapon, money, or minimap surface.
Reference
- This repository is a modified Project Sloth ps-hud fork.
- Keep upstream attribution and the GPL-3.0 license when redistributing modifications.