mirror of
https://github.com/Michatec/xhud.git
synced 2026-03-31 15:36:31 +02:00
main
xhud
xhud is a FiveM HUD for ox_core or ESX Legacy.
Dependencies
- ox_lib
This also requires a framework of your choice between ox_core and es_extended.
Note that if you are using ESX, you will also need esx_status and esx_basicneeds.
Download & Installation
- Go to the releases page and download the latest release
- Place it inside the
resourcesdirectory - Add the resource to your
server.cfgafter dependencies to make sure it's started correctly at server startup:
ensure xhud
Configuration
You can add these settings directly to your 'server.cfg', or add them to a separate file (i.e. hud.cfg) and call it with exec. Convars must be set before starting xhud.
The values below are defaults and should not be explicitly set unless changing the value.
### Shared
# Seabelt system
setr hud:seatbelt false
### Client
# Stress Indicator
setr hud:stress false
# Stamina Indicator
setr hud:stamina false
# Fuel Indicator
setr hud:fuel false
# Vehicles speed: "imperial" or "metric"
setr hud:unitsystem "imperial"
# HUD position: top, middle, bottom (default: bottom)
setr hud:position "bottom"
# HUD horizontal position: left, center, right
setr hud:hposition "left"
# Radar mode: by default, the radar is only enabled while sitting on a vehicle.
# Set this to true to have it always enabled. This will also enable the map cycler.
setr hud:persistentRadar false
# Radar shape
setr hud:circleMap true
# Keys for map cycler and seatbelt
setr hud:cyclemapKey "Z"
setr hud:seatbeltKey "B"
# Voice Indicator
setr hud:voice false
# Voice system: "pma-voice" or "saltychat"
setr hud:voiceService "pma-voice"
# Server logo
setr hud:logo true
# Version check against GitHub repo (Recommended)
setr hud:versioncheck true
Languages
Lua
50.9%
JavaScript
35.5%
HTML
8.2%
CSS
5.4%