Koja HUD
Koja HUD is a free, open-source HUD for FiveM, written in Lua and React. It replaces the GTA status display with player status bars, a speedometer, notifications, a progress bar, a text prompt and a vehicle control menu — and every player can restyle and rearrange it from an in-game settings menu.
This section covers version 1.1.0 of the resource koja-hud.
What you get
| Area | What is in it |
|---|---|
| Player status | Health, armour, hunger, thirst, stamina, oxygen, voice and stress, in 5 styles |
| Speedometer | 5 styles with gear, fuel (petrol or electric), nitro, seatbelt, engine, RPM, engine health, lights, indicators and cruise control |
| Messages | Notifications (3 styles), progress bar, text UI prompt, killfeed, status effects, low health and low fuel warnings |
| Information | Compass, weapon and ammo panel, cash, bank, job, server ID, clock, Discord link and logo, key hints, server watermark with a PVP mode |
| Minimap | A square minimap that players move and resize in-game |
| Vehicle | Engine, seatbelt, cruise control, nitro saved per owned vehicle, and a menu for doors, hood, trunk, lights and turn signals |
| Settings menu | /settings — styles, colours, visibility, a drag-and-drop layout editor and custom key binds, saved per player |
| Languages | English, Polski, Deutsch, Español, Français, Hindi |
Quick facts
- Resource name:
koja-hud— use it inensureand in everyexports['koja-hud']call. - Frameworks: ESX, QBCore, QBox and ox_core, detected by koja-lib.
- Requires:
koja-libandoxmysql.pma-voiceis optional and drives the voice bar. - Fuel: read through koja-lib —
ox_fuel,LegacyFuel, or the native fuel level. - Database: one
nitrocolumn, added to your owned-vehicles table on start. No tables of its own. - Licence: free and open source. The compiled UI ships in
web/build; the React source is inweb/src.
Start here
-
Install it
Installation — dependencies,server.cfgorder and the one setting you must change. -
Configure it
Configuration — every option ineditable/shared/config.lua. -
Set the player defaults
Player settings —js.json: what new players see, key hints, Discord and logo, and the settings menu itself. -
Learn what it does
Features — every component, and what players can change. -
Use it from your own code
Exports & Events — notifications, progress bars, text UI, status effects, killfeed, stress, nitro and visibility. -
Know what it stores
Database — thenitrocolumn and nothing else.
In this section
Dependencies, start order and the owned-vehicles table.
Every option in config.lua, explained.
Defaults, key hints, Discord, logo and the settings menu layout from js.json.
Status, speedometer, notifications, minimap, vehicle menu and more.
The client API for other resources.
Switch the language or add your own.
Build the React UI, and the NUI messages it listens to.
The nitro column on your owned-vehicles table.
Fixes for the problems people actually hit.