Skip to content

Documentation

Documentation for the Aurora scripts. Pick the one you are setting up.

A configurable HUD for FiveM, supporting Qbox, QBCore, ESX and standalone servers.

New here? Install it first, then type /hud in game. Almost every setting lives in that menu; the config/ folder only tells the HUD which of your other scripts to talk to.

Installation

Dependencies, server.cfg, and what happens on first start.

Install →

The /hud menu

Where players set their own layout, and where admins set what applies server-wide.

Open →

Integrations

Point the HUD at your fuel, inventory, notification, voice and phone scripts.

Configure →

Exports

The public API: hide the HUD, push your own statuses, feed the weapon widget.

Reference →

Translations

Edit the bundled languages, or add your own.

Translate →

Something is wrong

The Support panel reports what was detected and what failed since start-up.

Troubleshoot →