Installation
Install Aurora HUD on a Qbox, QBCore, ESX or standalone FiveM server.
Dependencies
Section titled “Dependencies”| Resource | Used for |
|---|---|
ox_lib |
Notifications, the menu’s callbacks, and the player and vehicle cache |
oxmysql |
Saving each player’s layout |
Both are free and open-source, by Overextended.
Install
Section titled “Install”-
Copy the
aurora_hudfolder into yourresourcesdirectory. -
Add it to your
server.cfg, after its dependencies:server.cfg ensure ox_libensure oxmysqlensure aurora_hud -
Grant yourself the admin tabs. The HUD has its own ace and nothing else opens them, not even the
commandace:server.cfg add_ace group.admin aurora_hud.admin allow # a groupadd_ace identifier.license:xxxxxxxxxxxxxxxx aurora_hud.admin allow # a personOne line is enough. Without it nobody sees the admin tabs, including the server owner. Contents in The /hud menu.
-
Start the server, join, and type
/hud. The menu opens if the install worked; the admin tabs appear if the ace landed.
First configuration
Section titled “First configuration”In rough order of how often each is needed:
| Step | Where |
|---|---|
| Point the HUD at the other scripts: fuel, inventory, notifications, voice, phone | config/client.lua, see Integrations |
| Set the server defaults: keybinds, logo, currency, default language | /hud admin tabs, see The /hud menu |
| Postal codes, optional | install nearest-postal, keeping that folder name. Hidden until it runs |
An inventory that is neither ox_inventory nor the framework’s own |
adapter in config/server.lua, see Inventories |
What it takes over
Section titled “What it takes over”Two things become the HUD’s at start-up, and both conflict with a resource already doing them.
| Taken over | Conflict |
|---|---|
The minimap: replacement round and square masks in stream/, and control of when the radar shows |
Another resource streaming minimap files or calling DisplayRadar. Symptom: a map that flickers or refuses to change shape |
| The native HUD components, while cinematic mode is on | Nothing else is suppressed permanently, so an existing HUD resource draws on top of this one. Stop it |
Database
Section titled “Database”Nothing to import. The aurora_hud_presets table is created on first start, one row per
player: layout and settings, widget unlocks, stress value.
Framework detection
Section titled “Framework detection”Detected at start-up: Qbox, QBCore, ESX, or none. The framework is not declared anywhere in the config.
On a standalone server the framework-fed widgets (job, wallet, hunger, thirst) stay dark until they are fed from another script. See Exports.