HUD · Project Sloth

ps-hud

The most widely installed custom HUD on QBCore servers: circular status rings, a compass, a speedometer and a minimap frame that matches them.

ps-hud replaced qb-hud on a very large share of servers because it looks finished out of the box and because everything on it can be toggled by the player. It sits directly around the minimap, which makes it the resource most likely to clash visually with a replacement map — the HUD frame, the compass strip and the map art all have to agree on a colour or the corner of the screen looks assembled from parts.

Official documentation Repository All resources

At a glance

Maintainer	Project Sloth
Latest release	2.1.2 · 2024-07-06
Last code change	2026-02-06
Licence	GPL-3.0
Written in	Svelte
GitHub stars	151
Status	Archived — no longer maintained

Figures read from the repository on 2026-09-22.

Three separate layers make up the minimap corner

Why servers run it

Player-configurable: every element can be moved, resized, recoloured or turned off from a menu.
Status rings for health, armour, hunger, thirst, stress, oxygen and stamina without a separate resource.
A speedometer, fuel gauge and seatbelt indicator that read at a glance while driving.
A minimap frame with configurable shape, which is what lets a server go square or circular.

Installing ps-hud

1. Install on QBCore
ps-hud targets QBCore. ensure it after qb-core; it replaces qb-hud, so stop that first.
2. Remove the old HUD
Two HUDs means two speedometers. Comment out qb-hud in server.cfg rather than deleting it, so you can go back.
3. Match your map
Set the HUD accent to the same colour family as your minimap. A cyan HUD around an amber map is the most common avoidable ugliness on a server.
4. Decide on the minimap shape
ps-hud can render a square or circular frame. The frame is the HUD; the mask that actually cuts the map is a separate texture.

Working examples

Toggling the HUD from another script

-- Hide the whole HUD during a cutscene or a loading sequence
TriggerEvent('hud:client:ToggleHudDisplay', false)

-- and bring it back
TriggerEvent('hud:client:ToggleHudDisplay', true)

Feeding a custom stress value

TriggerEvent('hud:client:UpdateStress', stressLevel)

What goes wrong

The HUD frame is not the minimap mask. Turning on a circular frame in ps-hud draws a round border around a rectangular map. Actually cutting the map to a circle is a texture swap.

Two HUDs stack silently. qb-hud and ps-hud both draw; the result looks like a rendering bug.

Player settings are stored per client. A change you make while testing will not apply to anyone else, which makes 'it looks wrong for me' reports hard to reproduce.

Recolouring the HUD does not recolour the map. The map is a streamed texture and has to be rebuilt in the new palette.

ps-hud — questions people ask

Does ps-hud change the minimap image?

No. It draws the frame, the compass and the gauges around the map. The map itself is a texture streamed by a separate resource, which is why a HUD change and a map change are two different jobs.

How do I make the minimap circular?

The HUD can draw a round frame, but the map is still cut to a rectangle by the radar mask texture. A genuinely circular minimap needs the mask replaced as well.

Is ps-hud QBCore only?

It targets QBCore. ESX forks exist but are community maintained and lag behind.

Runs alongside

qb-hud

QBCore's bundled HUD — the default status icons, speedometer and minimap frame on a stock install.

qb-core (QBCore)

The roleplay framework most new FiveM servers are built on, with the largest modern script ecosystem and a one-click txAdmin recipe.

ox_lib

The shared library half the modern FiveM ecosystem depends on: menus, notifications, progress bars, zones, callbacks and a cache.