Installation

📋 Requirements

Resource
ox_lib	Required
Qbox, QBCore or ESX	Detected automatically

Detected automatically (optional)

Type	Supported
⛽ Fuel	ox_fuel, LegacyFuel, cdn-fuel, ps-fuel, lj-fuel, Renewed-Fuel, nd_fuel, lc_fuel, okokGasStation, qs-fuelstations, rcore_fuel, hyon_gas_station
🎙️ Voice	pma-voice, SaltyChat
🔫 Weapon names & images	ox_inventory, qb-core shared weapons
📮 Postal codes	Built in (`data/postals.json`). If nearest-postal is running, its codes are used instead
🪢 Seatbelt	qbx_seatbelt, kartik-mechanic, or the built-in seatbelt
🔧 Mechanic	kartik-mechanic: nitro, TCS / ESC, harness, manual gears and mileage
🚦 Cruise control	qbx_smallresources, or the built-in cruise control

🚀 Installing

Drop kartik-hud into your resources folder.
Stop your old HUD. qbx_hud, qb-hud and similar must not run alongside it, kartik-hud replaces them, including their stress handling.
Make sure it starts after ox_lib and your framework:

ensure ox_lib
ensure qbx_core        # or qb-core / es_extended
ensure kartik-hud

Restart your server and join. The HUD appears as soon as your character loads.

The console prints [HUD] Detected Framework: qbx (or qb / esx) on start. If it prints an error instead, your framework is not started before kartik-hud.

👑 Admin access

Two things need admin rights, both controlled by ACE permissions:

What	Config	Default
Saving the server default HUD in `/hud`	`Config.AdminAce`	`command`
Opening the HUD Builder (`/hudbuilder`)	`Config.Builder.ace`	`command`

command is the permission txAdmin and server admins already have. To give it to a group instead:

add_ace group.admin kartik.hud allow

and set Config.AdminAce = "kartik.hud" and Config.Builder.ace = "kartik.hud".

💾 Saved data

kartik-hud needs no database.

What	Where
Each player's own HUD	Their game client (resource KVP)
The server default HUD	`data/defaults.json`
HUD Builder designs	`data/designs.json`

Back up data/designs.json before updating the resource, it holds every design your admins have built.

✅ First steps

Type /hud and pick a theme, speedometer and status style.
Click Edit Layout at the bottom of /hud to lay the HUD out.
As an admin, press Save as default in /hud → General → Admin. Every new player starts with your layout.
Try /hudbuilder to design your own HUD, see HUD Builder.

Installation

📋 RequirementsCopy Anchor Link

Detected automatically (optional)Copy Anchor Link

🚀 InstallingCopy Anchor Link

👑 Admin accessCopy Anchor Link

💾 Saved dataCopy Anchor Link