Configuration

Where hunger, thirst, stress and money come from. 'auto' tries Qbox, then QBCore, then ESX. Set 'qbx', 'qb', 'esx' or 'standalone' to choose one. Standalone shows no hunger, thirst or money pops.

Which fuel script the gauge reads. 'auto' picks the first one running.

Whose seatbelt the HUD shows. 'auto' shows a known seatbelt script's belt when one runs (ls_utils, qbx_seatbelt, qb-smallresources, esx_cruisecontrol), otherwise nx_hud's own. 'own' always uses nx_hud's belt. 'external' shows only a seatbelt script's belt, and no belt when none runs.

The stress gauge. 'auto' shows it only when your framework or a stress script provides stress. false hides it.

The accounts whose changes pop up on the island. Other scripts can show a pop for any account with the moneyPop export.

nx_hud's own seatbelt. false turns it off: no belt key, no ejection, no chime.

Default key that buckles and unbuckles the belt.

An unbuckled crash above this speed throws the player through the windscreen. false never ejects.

Above this speed an unbuckled player hears the chime and sees the red belt light.

Turn signals and hazard lights for the driver, seen by every player.

Default keys for the left signal, the right signal and the hazard lights.

A turn signal switches itself off after the turn.

true shows passengers the vehicle HUD too: the cluster, the loupe or the capsule. false gives passengers the on-foot HUD. The windscreen HUD is always the driver's alone.

GTA's own HUD text that nx_hud hides: 6 the vehicle name, 7 the area name, 8 the vehicle class, 9 the street name. {} hides none.

Strict-hide nx_hud while the player is dead, so nothing draws over your death screen and notifications wait until the player is up. Works with ESX, QBCore, Qbox (qbx_medical) and plain GTA deaths. false leaves it to your scripts (exports.nx_hud:SetStrictHidden).

Also while the player is downed in last stand (QBCore, Qbox).

The server's language for the whole HUD: 'en', 'fi', 'de', 'fr', 'pt-br', 'es', 'tr', 'nl', 'it' or 'pl'. Players can pick their own in the /ox_lib settings menu. A setr ox:locale line in server.cfg overrides it. A line missing from a translation falls back to English.

false runs the HUD only. Scripts that need ox_lib then fail to load with a clear message.

Which interface draws each ox_lib component.

ui = {
    notify = 'nx', textui = 'nx', progress = 'nx', alert = 'nx', input = 'nx',
    context = 'nx', menu = 'nx', radial = 'nx', skillcheck = 'nx', clipboard = 'nx',
},

Drop or reword single notifications from other scripts, and keep nx_hud's notifications for all the rest. It works with every Compat.ui.notify setting.

notifyFilter = function(data, resource)
    if data.description == 'Laptop packed up.' then return false end
    if resource == 'my_garage' and data.type == 'error' then
        return { title = 'Garage', description = data.description, type = 'warning' }
    end
end,

Default key for the radial menu. Players can rebind it in Settings, Key Bindings, FiveM.

Context menus. 'keys' is a keyboard menu and the player keeps moving. 'pointer' is the classic mouse menu that holds the player in place.

What happens to the scripts that depend on ox_lib when nx_hud restarts. FiveM stops them with it. resurrect starts them again in their original order, one every stagger milliseconds. never lists names that must stay stopped. A full server restart is still the safe way to restart nx_hud.

Scripts that call exports.ox_lib directly keep working after an nx_hud restart.

Let scripts that call lib.versionCheck look for new versions on GitHub.

true releases a key that was held through the pause menu, instead of leaving it pressed in scripts.

Show ESX's own interface calls in nx_hud. notify covers esx_notify and textui covers esx_textui, each only while that ESX resource is stopped or not installed. progress and context are reserved and have no effect yet.

false turns the inventory off. The HUD and the ox_lib layer keep running.

Keep the inventory on although a folder named ox_inventory is still installed. Not recommended.

Run the inventory even when ox_lib is not nx_hud.

Walking with the inventory open. 'always', 'drops' (only next to a drop) or 'never' (ox_inventory's freeze).

Resources that get the inventory handed to them again each time they start. es_extended needs it.

Tell scripts that wait for ox_inventory to start that it has. esx_addoninventory needs it.

Minutes between saves of changed inventories.

The most files nx_hud may ship, item images included. Clients fail to connect somewhere above about 1,500. nxinv migrate apply copies images within this budget.

Keep items that no longer exist in data/items.lua aside instead of deleting them. List and restore them with nxinv orphans.

TAB shows the hotbar until TAB is pressed again. false shows it for three seconds, as ox_inventory does.

ox_inventory's secondary key (K) for trunks, gloveboxes, dumpsters and stashes. false registers no such key, so it never clashes with other scripts' keys. true brings it back.

A Glovebox item in the radial menu while the player sits where the glovebox opens, in a vehicle that has one.

Point inventory:imagepath at nx_hud's image folder, so item pictures load.

Log every ox_inventory call by resource. Also nxinv trace on and off.

The most actions per player per second. Over the limit the action is refused and logged. Nobody is kicked.

Extra metres allowed between a player and an open inventory before an action is refused.

How far away another player can be to receive an item.

How close another player must be to appear in the give picker. Never more than rules.giveRange.

Reach for opening a shop and buying from it.

Reach for using a crafting bench.

Reach for buying a licence at its counter.

Reach for searching another player.

Reach for opening a dumpster.

A drop lands at most this far from the player. Applies while strict.dropClamp is on.

A dumpster's size. Weight is in grams.

Crafts a player can queue behind the one that is running.

The most of one item a single shop purchase can buy. The amount picker in the shop stops there too.

What shop items without their own currency are paid with, in shops that name no payment. The player picks in the shop; the first is the default. 'money' is cash, 'bank' is the card. Set { 'money' } for cash only, as in ox_inventory. A shop's own payment field wins.

The getInventory and getItemCount callbacks answer only for the caller's own inventories.

A drop lands within rules.dropClamp metres of the player.

Giving an item needs both players in the same routing bucket.

Shops on props, such as vending machines, check that the buyer stayed next to the prop.

A client opens a per-player stash only as its own owner.

Items that open as their own inventory, keyed by item name.

containers = {
    paperbag = { slots = 5, maxWeight = 1000, blacklist = { 'testburger' } },
    pizzabox = { slots = 5, maxWeight = 1000, whitelist = { 'pizza' } },
},

false removes Show from the item menu.

How far away, in metres, players see the card. 0.5 to 15.

How long the item is shown, in milliseconds. 2000 to 20000.

Milliseconds between two shows by the same player.

The animation played while the item is shown.

A prop in the hand while an item is shown, keyed by item name.

props = {
    id_card = { model = 'prop_franklin_dl', bone = 28422, pos = { 0.084, 0.02, -0.026 }, rot = { -173.85, -88.0, 63.06 } },
},

Drag one item onto another in the pockets to make something. Each entry is a recipe. Other scripts add recipes with registerCombine.

combine = {
    { items = { 'coat_hanger', 'tool_kit' }, consume = { coat_hanger = 1, tool_kit = 0 }, result = { { 'lockpick', 2 } }, duration = 2500 },
    { items = { 'blank_card', 'card_skimmer' }, consume = { blank_card = 1, card_skimmer = 0 }, result = { { 'cloned_card', 1 } }, duration = 3000 },
    { items = { 'scrap_electronics', 'copper_wire' }, consume = { scrap_electronics = 2, copper_wire = 1 }, result = { { 'radio', 1 } }, duration = 4000 },
},

false turns carrying off. Carry items then sit in the pockets like any other item.

The preset an item with carry = true uses.

'hide' hides the prop while the carrier is dead or downed. 'keep' leaves it in their hands. A preset or an item can set its own.

Named carry styles that items can use. Add your own to reuse it on several items.

carry = true,                                    -- the default preset
carry = 'heavy',                                 -- a preset by name
carry = { preset = 'box', pos = { 0.0, 0.1, 0.25 } },   -- a preset with fields changed
carry = { preset = 'heavy', model = 'my_prop', bone = 28422, pos = { 0.2, 0.0, 0.0 }, rot = { 0.0, 90.0, 0.0 } },   -- your own prop

false turns worn gear off. Items worn before then come back into the pockets.

true: the watch and bracelet props belong to items, so a wrist with nothing worn is bare and the character creator's watch goes. false: nothing is ever cleared, and taking an item off gives back what the ped wore before. Clothing components (bags, vests) are never cleared.

The places an item can be worn. Each socket names a ped prop anchor (prop) or a clothing component (component), and a label.

sockets = {
    back = { component = 5, label = 'Backpack', look = true },
    vest = { component = 9, label = 'Vest', look = true },
    watch = { prop = 6, label = 'Watch' },
    bracelet = { prop = 7, label = 'Bracelet' },
},

The gear column in the inventory, top to bottom. It is also the order in which an item that fits several sockets looks for a free one, so with the default a wrist item goes on the left wrist first. An item can change that for itself with accessory.order.

false turns plate carriers off.

The item a plate turns into when it reaches 0. It goes into the pockets, or to the ground when it does not fit. false: the plate is gone.

Milliseconds to fit a plate. At most 4500.

Milliseconds to take a plate out. At most 4500.

The animation played while a plate goes in or comes out.

false stops nx_hud from answering for ox_target and qtarget.

Stay on while a stopped ox_target or qtarget folder is still installed.

Remove a stopped script's global options too. ox_target leaves them behind.

Forget a local entity's options when the game reuses its handle for another model.

How often, in milliseconds, options of deleted local entities are forgotten.

The most rows one target shows.

Also list options the player lacks the job or item for, with what they need.

How long, in milliseconds, an open menu stays up when the aim slips off the object for a moment. 0 closes it at once.

An open menu stays while the aim passes this close to the object, in metres, or through the zone. Nothing in front of it counts: a wall still closes it. 0 turns it off.

Opens a scripted prop when the aim passes through it, or this close to it, in metres, even when the prop's collision is missing or smaller than the model. Only props registered by model, entity or local entity count, never global options. Nothing in front of it counts: a wall still blocks it. 0 turns it off.

Dots on nearby things a player can use, for every player. This is a server setting: players cannot turn dots on or off in F7.

How far away, in metres, dots appear.

'ttl' shows a dot only where its option is usable, reusing the answer for ttlMs. 'never' shows dots without asking the option.

How long a dot's usable answer is reused, in milliseconds.

The most usable checks per dot scan.

Show zone dots while the target key is held, even with dots.enabled off.

No dots through walls.

The most extra line-of-sight checks per dot scan, for props set into a wall and for zones.

Per-player limit on option lookups a minute.

Metres between a player and a vehicle whose door they open or close through targeting.

Tell scripts that ox_target started when nx_hud starts.

Log every target export call by resource.

The vehicle mode: 'cluster', 'loupe' or 'island' (the capsule).

The cluster face: 'a' (Classic), 'b' (Arcs) or 'c' (Sweep).

The glass quality: 'hero', 'full' or 'off'. 'off' is the lightest on the graphics card.

Speed units: 'mph' or 'kmh'.

The radar shape: 'square', 'squircle' (Soft), 'circle' (Round) or 'auto'.

How far the radar reaches, in metres, 90 to 450. 150 is GTA's own.

Radar zoom: 'manual', or 'auto', which widens it with speed.

Where prompts and progress bars appear: 'island' (on the island) or 'near' (near the action).

The radial menu's look: 'beads' or 'bezel'.

Interface sounds.

Interface sound volume, 0 to 100.

The inventory layout: 'centre' or 'compact'.

The targeting look: 'tether' or 'bloom'.

'auto' sends to fxlogs while it runs, 'fxlogs' the same, 'none' logs nothing.

Inventory admin commands: /giveitem, /removeitem, /setitem, /clearinv, /takeinv, /restoreinv, /saveinv, /viewinv and clearActiveIdentifier (admin, warn).

Licence purchases (economy, inventory.licence.buy).

Shop purchases paid by card, a society account or your own payment method: where the money came from (economy, inventory.shop.pay).

Items combined in the pockets (inventory, inventory.combine).

Police evidence lockers cleared (crime, inventory.evidence.clear).

Refused exploit attempts (anticheat, inventory.exploit; alert when the player was dropped).

Zones saved with /zone (admin, lib.zone.save).