KS-HUD

Installation

1. Unzip the delivered archive into your resources/ folder, under the name ks-hud.
2. Import the provided install.sql file into your database.
3. Add ensure ks-hud to your server.cfg, after oxmysql and qb-core.
4. Restart your server.

Configuration

Config.Elements = {
  health = { enabled = true, position = "bottom-left" },
  hunger = { enabled = true, position = "bottom-left" },
  minimap = { enabled = true, showSpeed = true, showFuel = true },
}
Config.CompactModeKey = "F7"

Each element can be disabled or repositioned independently, useful for freeing up space when another interface script already occupies part of the screen.

Adding a job indicator

A custom indicator can be registered for any job:

exports['ks-hud']:RegisterJobIndicator('police', {
  label = "En service",
  icon = "fa-solid fa-shield-halved",
  getValue = function(src) return QBCore.Functions.GetPlayer(src).PlayerData.job.onduty end,
})

getValue is re-evaluated periodically — return the value to display (text, boolean or number) to match the chosen icon.

Common issues

The HUD overlaps another interface script. Adjust Config.Elements[element].position to free up the area used by the other interface, or temporarily disable the element with enabled = false.

The minimap doesn’t show speed or fuel. Check that showSpeed and showFuel are set to true, and that your fuel script exposes a readable value (KS-HUD reads exports['your-fuel-script']:GetFuel(vehicle) by default, configurable in Config.FuelExport).