Configuration
All configuration lives in a single file: config.lua.
Do not modify any other file — changes to client/main.lua or html/app.js will be lost on updates.
Framework
Config.Framework = 'auto'
-- 'auto' → detects ESX, QBCore, qbx_core or standalone automatically
-- 'esx' → forces ESX
-- 'qbcore' → forces QBCore
-- 'qbox' → forces qbx_core
-- 'standalone' → disables all framework bridges
Use 'auto' unless you have more than one framework installed (uncommon) or want to force standalone for compatibility reasons.
Stat rings
Config.Stats = {
health = true, -- Health (GTA native)
armor = true, -- Armor (GTA native)
hunger = true, -- Hunger (ESX / QBCore / QBox — hidden in standalone)
thirst = true, -- Thirst (ESX / QBCore / QBox — hidden in standalone)
stress = true, -- Stress (QBCore / QBox — hidden on ESX/standalone)
stamina = true, -- Stamina (GTA native)
oxygen = true, -- Oxygen (GTA native, only visible underwater)
voice = true, -- Voice (requires pma-voice)
}
Set any value to false to permanently disable that ring on the server. Players can also hide them individually from /hub.
Speedometer
Config.Vehicle = {
enabled = true,
units = 'kmh', -- 'kmh' | 'mph'
showFuel = true,
showGear = true,
showSeatbelt = true,
-- Speed limiter
speedLimiterEnabled = true,
speedLimiterKey = 'LSHIFT', -- RegisterKeyMapping key (rebindable in FiveM Settings)
speedLimiterMin = 10, -- minimum km/h required to engage the limiter
}
Speed limiter
Press the configured key (LSHIFT by default) while driving to lock the current speed as the maximum. Press again to release. The limiter disables automatically if:
- You exit the vehicle.
- You change vehicles.
- You stop being the driver.
The player can rebind the key at: FiveM → Settings → Key Bindings → FiveM.
Fuel script
Config.FuelScript = 'auto'
-- 'auto' → detects automatically
-- 'ps-fuel'
-- 'LegacyFuel'
-- 'ox_fuel'
-- 'qs-fuel'
-- 'cdn-fuel'
-- 'hfuel'
-- 'native' → uses GTA's native fuel (always 100%)
If auto-detection fails (fuel always at 0 or 100), set the exact name of your fuel script.
Reserve warning: when the level drops to ≤20%, an orange LED is shown on the speedometer and a dashboard-style chime plays.
Seatbelt
Config.Seatbelt = {
warnSpeed = 30, -- km/h above which the warning beep plays when unbelted
ejectSpeed = 35, -- deceleration delta (km/h) that triggers ejection without a seatbelt
}
The system uses deceleration delta: it measures the speed difference between ticks. If the reduction is ≥ ejectSpeed km/h within 100 ms and the player has no seatbelt, they are ejected with force and duration proportional to the severity.
Key: B by default (configurable via RegisterKeyMapping → rebindable in Settings).
To disable ejection but keep the audio warning, set ejectSpeed = 9999.
Refresh rates
Config.Tick = {
player = 250, -- ms between stat updates
vehicle = 50, -- ms between speedometer updates
}
Toggle command
Config.ToggleCommand = 'hud' -- type /hud in chat to hide/show the HUD
Change the command name if another resource is already using /hud.
Branding
Config.ShowLogo = true
Config.LogoPath = 'assets/logo.svg' -- path relative to html/
Config.LogoLabel = 'FiveRank' -- text below the logo ('' to hide)
Supported logo formats: SVG, PNG, WEBP.
Place the file in html/assets/ and update Config.LogoPath.
Language
Config.Locale = 'en' -- es | en | pt | fr | de
Players can change their personal language from the /hub panel — saved per player via KVP.
→ See Languages for more details.
All options summary
| Key | Default | Description |
|---|---|---|
Config.Framework | 'auto' | Framework to use |
Config.Stats.health | true | Health ring |
Config.Stats.armor | true | Armor ring |
Config.Stats.hunger | true | Hunger ring |
Config.Stats.thirst | true | Thirst ring |
Config.Stats.stress | true | Stress ring |
Config.Stats.stamina | true | Stamina ring |
Config.Stats.oxygen | true | Oxygen ring |
Config.Stats.voice | true | Voice ring |
Config.Vehicle.enabled | true | Floating speedometer |
Config.Vehicle.units | 'kmh' | Speed units |
Config.Vehicle.showFuel | true | Show fuel |
Config.Vehicle.showGear | true | Show gear |
Config.Vehicle.showSeatbelt | true | Show seatbelt |
Config.Vehicle.speedLimiterEnabled | true | Speed limiter |
Config.Vehicle.speedLimiterKey | 'LSHIFT' | Limiter key |
Config.Vehicle.speedLimiterMin | 10 | Minimum km/h to engage |
Config.FuelScript | 'auto' | Fuel script |
Config.Seatbelt.warnSpeed | 30 | Warning speed (km/h) |
Config.Seatbelt.ejectSpeed | 35 | Deceleration delta for ejection |
Config.Tick.player | 250 | Stats refresh (ms) |
Config.Tick.vehicle | 50 | Speedometer refresh (ms) |
Config.ToggleCommand | 'hud' | Hide/show command |
Config.ShowLogo | true | Show logo on screen |
Config.LogoPath | 'assets/logo.svg' | Path to logo |
Config.LogoLabel | 'FiveRank' | Server label |
Config.Locale | 'es' | HUD language |