A roleplay HUD for FiveM with stat bars, wanted stars, a vehicle card, a framed minimap, a weapon and item wheel and a small chat of its own.

nCore Development · intelnpc.com · Resource: ncore_vibehud · Version: see fxmanifest.lua

What it is#

Vibe HUD takes the stock GTA V HUD pieces off the screen and draws one designed interface in their place. It shows your stats, needs, wanted level, money, vehicle, location and minimap, and it adds a weapon and item wheel on TAB and a small roleplay chat.

It needs no other resource. A framework is optional, and it detects your framework, inventory and fuel resource on its own. The layout is built for 1920x1080 and scales with your screen height and the game's safe zone. Players change a lot of it in /vibehudsettings, and other scripts can drive it through 82 client exports and 17 server exports, listed in DOCUMENTATION.md.

Features#

Screen and layout#

• Scales with screen height (1080 is the base size) and sticks to the game's safe zone on all corners.
• Server-wide size in Config.Hud.scale. Each player can set 0.7 to 1.6 for themselves with /vibehudscale <n> or the settings slider, and it is remembered.
• Hides the stock wanted stars, cash, vehicle, area and street names, weapon icon and the health and armor arcs while Vibe HUD is shown. Everything is given back when the resource stops.
• Shows only for a loaded character who is in the world. It waits for the loading screen (ncore_loading and the other ncore loading screens), for the ncore_character creator and for a script camera such as a character selector. If the framework never fires its event, a 30 second safety net (Config.Hud.spawnFallbackMs) shows it anyway.
• Hides while the screen is faded, during a sky-camera player switch and in the pause menu (Config.Hud.hideInPause). Hiding it when dead is optional (Config.Hud.hideWhenDead).
• Players can switch the whole HUD off for themselves with /vibehud. The chat stays usable.
• Bundled fonts: Oswald, Inter and Anton. Nothing to install.
• UI sounds can be a bundled file, a GTA frontend sound or off. Players can mute them.
• Open web/index.html in a browser to preview the design with demo data, outside the game.

Stats and needs#

• Health, armor, stamina and oxygen as a column of bars. Armor shows only while you wear it, stamina only when it is not full, oxygen only underwater or in a submarine.
• Health gets divider segments every segmentEvery HP, and the bar grows with max health.
• Hunger, thirst and stress bars appear when your framework (or a script) reports a value. QBCore and QBox metadata, qb-hud events, esx_status and state bags are read.
• Character progression: two minutes of sprinting adds one stamina stat point, two minutes of swimming adds one lung capacity point. A higher stat stretches the stamina and oxygen bar.
• Scripts can override any stat, its max and its segments with SetStat, SetStatMax and SetStatSegments.

Wanted level and suspect icons#

• Wanted stars from 0 to 6, read live from the game. They blink while police are searching and fade when you are losing them.
• Six evidence icons while you are wanted, checked every second: CCTV, group, appearance, profile, weapon and vehicle. The CCTV icon looks for a camera prop within range with a clear line to your head. It has no field-of-view test.
• Each icon can be turned off in config. Scripts can set the wanted state and the suspect table with SetWanted and SetSuspect.

Money#

• Cash, bank and dirty money rows with their own colors and icons. A +/- flash shows on a change.
• Display mode always, or onchange (visible for 6 seconds after a change).
• Cash and bank come from ESX, QBCore or QBox. Dirty money is read from the black_money account on ESX, from markedbills items on QBCore, and from an ox_inventory black_money item on QBox.
• Scripts can add their own rows with SetMoney and SetMoneyRow, which also works on standalone.

Special ability#

• The GTA special ability bar, as focus (bullet time) or rage. Press CAPS LOCK to use it (rebindable), once it has at least 25 charge.
• Charge comes from kills, headshots, near misses and stunts. Players pick focus, rage or off with /vibehudability.
• Exports: SetAbilityCharacter, ChargeAbility, GetAbility.

Vehicle card#

• Make and model, speed in km/h or mph, RPM bar, and fuel, engine and body rings with amber and red warning colors.
• A gear badge. It shows P (parking brake), R, N (engine off) or D plus the gear number. Helicopters and planes show altitude instead.
• Tell-tale icons for headlights, engine, door locks, belt or harness, cruise, limiter, parking brake and the indicators.
• Fuel is read from 13 fuel resources (LegacyFuel, ps-fuel, lj-fuel, lc_fuel, cdn-fuel, myFuel, nd_fuel, okokGasStation, hyon_gas_station, ti_fuel, rcore_fuel, qs-fuelstations, x-fuel), or from the fuel state bag.
• The card has its own style for bicycles (no RPM, fuel or engine rings) and for helicopters and planes (no RPM).
• Seatbelt with /belt or B (rebindable) and an unbelted chime above 30 km/h. A racing harness buckles automatically for supercars and open-wheel cars, for players holding a harness item, or when a script sets LocalPlayer.state.lrHarness.
• Turn indicators and hazards on LEFT, RIGHT and DOWN. They drive the real lamps and sync to every client that sees the vehicle.
• Cruise control on J or /cruise [n]. Speed limiter with /limiter [n]. Parking brake with /parkbrake.
• Card, seatbelt, indicator, cruise, limiter and parking brake exports for other scripts.

Minimap and location#

• A frame on top of the game radar, aligned to the radar rectangle. With a waypoint it shows the road distance in km and m, or mi and ft.
• Radar calibration with /vibehudradar.
• A location card with street, zone or both, and a water style when you swim or boat.
• Postal codes from 1,687 bundled points (DevBlocky/nearest-postal, MIT, license in data/POSTALS-LICENSE), updated every 20 m.

Weapon and item wheel#

• Hold TAB to open an 8-slot weapon ring in the game's order: melee, pistol, SMG, shotgun, rifle, sniper, heavy, throwable.
• Each slot shows the weapon picture, name and magazine and reserve ammo, and your equipped weapon glows. Scroll over a slot to cycle the weapons in it. Release TAB or click to equip.
• The world blurs, firing is blocked and the stock wheel parts are hidden while it is open. It closes on ESC, death or pause without equipping anything.
• An ITEMS page on the same wheel (arrow keys or click the tabs). You can use an item, assign it to a slot, take it off a slot or give it to the nearest player.
• A right-click menu per slot. Weapons get Equip or Holster and an ammo line.
• Quick-use cards above the minimap for a bandage (key 1) and a medikit (key 2). When your inventory owns the number keys, the cards mirror its hotbar instead.
• Works with ncore_inventory, ox_inventory, qb-inventory, qs-inventory, the QBCore or QBox built-in inventory, ESX and a standalone item store. Not every inventory exposes every feature, so the item hover card, Give and holster depend on what your inventory offers.
• 262 bundled item pictures and 111 bundled weapon pictures. Your inventory's own image folder is used first.
• The wheel has the game's weapons built in (96 entries, the Mk II versions included). Add-on weapons show up when your inventory keeps weapons as items (ncore_inventory, ox_inventory, qb-inventory, qs-inventory or the QBCore or QBox built-in one). They go into the slot of their GTA weapon group with the inventory's label. Without such an inventory, an add-on weapon only shows while it is in your hand.
• Wheel exports: OpenWheel, CloseWheel, IsWheelOpen, GetWheelKey, SetMedicine, UseQuickSlot, GetInventoryBackend.

Chat and screen messages#

• A built-in chat that starts on its own when neither chat nor ncore_chat is running, and steps aside when either of them starts. Force it on or off with Config.Chat.enabled.
• T opens it. Channel tabs ALL, LOCAL OOC, OOC and SYSTEM, plus ADMIN once a staff line arrives. Command suggestions with parameter help, input history, scrolling and a character counter.
• Stock chat:addMessage, chatMessage and the suggestion events keep working. Color codes and HTML are stripped from incoming lines.
• Proximity chat: plain text reaches players within 20 m. /me, /do, /looc and /b, /ooc, /w (5 m), /s (60 m), /roll, /try, /a for staff, /announce, /ignore and /clear. The 11 commands can be renamed and the 9 colors changed in config.
• Character names come from ESX, QBCore or QBox, otherwise the account name. A line with @name or @id highlights and plays a sound.
• A rate limit of 5 lines per 2 seconds per player. Server events and exports let other scripts send, read and block chat lines.
• Mission status panel: one label and value row, race position, a timer and a par time with gold, silver and bronze medals.
• Hold-to-interact prompts with a key cap and a fill ring, several at once. Help box, and a subtitle or objective line with color codes.

Settings and tools#

• /vibehudsettings opens a panel with six pages: General, Vehicle, Radar, Parts, Chat and Keys. Players choose the speed unit, sounds, the belt chime and indicator tick, the radar mode, the special ability, which of the 12 HUD parts show, and three chat options (timestamps, ids and tabs). Preferences are saved on the player's machine. Config.Settings.enabled = false removes the panel.
• The layout is one fixed design. Players can scale it and hide parts, but there is no editor for moving pieces around.
• Languages: English and Hungarian. auto follows the server or the game language. The bundled fonts have no ő or ű, so in Hungarian those two letters are drawn in a fallback font and look a bit different from the rest of the text.
• /vibehuddebug opens a live debug panel and /vibehudreport prints a report to the F8 console.
• /vibehudunstuck closes the chat and gives the cursor back.
• /vibehuddemo and /vibehudshowcase run a tour of every element. /vibehudweapons and /vibehuditems hand out test weapons and items. They need the ace ncore.vibehuddemo while Config.Demo.restrict is on. /vibehuditems follows Config.Demo.itemsRestrict instead, and weapons given into an item inventory always need the ace.

Requirements#

• FXServer with OneSync recommended. Proximity chat ranges and the replicated seatbelt and indicator states need it. Without OneSync the server can't read player positions, so chat lines go to everyone and the console says so once.
• Nothing else. Optional: ESX, QBCore or QBox, a supported inventory, a supported fuel resource, ncore_hud, ncore_chat, ncore_loading.
• With ncore_hud running too, its band, cluster, weapon panel and minimap control stand down while Vibe HUD runs. ncore_hud keeps the indicators, belt, cruise, parking brake and limiter, and Vibe HUD shows their state (Config.Siblings).

Commands and keys#

B, T, J, CAPS LOCK, the indicator keys and the wheel key can be rebound in GTA Settings > Key Bindings > FiveM. While Config.Wheel.useControl is on, the wheel also opens on the game's own weapon wheel input (TAB), so turn that off if you move the wheel to another key. The quick-use keys 1 and 2 are the game's weapon slot inputs, set per slot in Config.Items.quickSlots. The HUD toggle, settings, debug, limiter and parking brake keys are empty by default, set them in config.lua.

Config files#

• config.lua: framework and inventory pinning, scale, element switches, vehicle, wheel and items, chat, sibling options, debug and demo. Every part has its own enabled switch.
• locales/en.lua and locales/hu.lua: all texts.
• bridge/client.lua, bridge/inventory.lua and server/bridge.lua: how framework and inventory data is read.

All of these stay editable in the Escrow edition. See INSTALLATION.md for the setup steps and DOCUMENTATION.md for exports, events and convars.

What is in the download#

The ncore_vibehud resource with the files above, the web UI with its fonts (Oswald, Inter and Anton, OFL license in web/assets/fonts/OFL.txt) and sounds, 111 weapon and 262 item pictures, 1,687 postal points in data/postals.json, and README.md, INSTALLATION.md, DOCUMENTATION.md and CHANGELOG.md.

Updating#

Download the new version (Escrow from your Cfx.re account, Full source from Tebex). Keep your config.lua, your language files and any bridge file you changed, and copy the other files over. CHANGELOG.md lists what changed. Players need to reconnect once if anything under web/ changed, because the client caches the page.

Common questions and fixes#

Players can scale the HUD from 0.7 to 1.6 and hide any of the 12 parts, but they can't move pieces. The layout is one fixed design.

The UI is drawn for 1080p and scales with the screen height, so 1440p is 1.33 and 4K is 2.0 before the player's own scale. Config.Hud.scale adds a server-wide size on top.

To add a language, copy locales/en.lua to a new file, change LRHLocales.en in it to your language code, translate the lines and set Config.Locale to that code. Lines you leave out show in English. With Config.Locale = 'auto', a setr locale convar (for example setr locale hu-HU) picks the language, otherwise each player gets the game's language if a locale for it exists, else English.

If the HUD doesn't show after spawning, it is waiting for a loaded character, a loading screen or a selector camera. /vibehuddebug shows whether it counts the player as ready and logs the reason each time the HUD hides, and the 30 second safety net (Config.Hud.spawnFallbackMs) brings it up on a framework that never sends its loaded event.

If the frame and the radar don't line up, run /vibehudradar, or nudge Config.Minimap.calibration. Config.Minimap.mode is follow by default, which leaves the radar where the game draws it and puts the frame on top. move puts the radar under the design's own frame and needs calibrating.

If the fuel ring looks wrong, the vehicle block of /vibehuddebug names the fuel resource it found. Pin the right one with Config.Vehicle.fuel, or set native to skip the fuel resources and read the fuel state bag or the game's own fuel level.

If ox_inventory also puts its hotbar on TAB, see INSTALLATION.md. The F8 console warns about it a few seconds after the resource starts.

If the cursor stays on screen, /vibehudunstuck closes the chat and gives it back. For a support request, run /vibehudreport and send what it prints to the F8 console.

Support#

Support is on intelnpc.com and I reply within 72 hours. Refunds follow the Tebex terms.

Vibe HUD is made by nCore Development. It is not approved, sponsored or endorsed by Rockstar Games.

1. Copy the ncore_vibehud folder into resources/[ncore] (create the [ncore] folder if you do not have one yet).
2. Add these lines to server.cfg, after your framework and inventory:

ensure ncore_hud      # optional
ensure ncore_chat     # optional
ensure ncore_loading  # optional
ensure ncore_vibehud

3. Put your inventory's item names in Config.Items.quickSlots and Config.Items.wheelItems in config.lua.
4. Give staff the chat and demo aces:

add_ace group.admin ncore.vibehudchat.admin allow
add_ace group.admin ncore.vibehuddemo allow

5. Restart the server. The console prints the version, the framework and the inventory it found.
6. Join and run /vibehudreport if something looks off. It prints the framework, the inventory, the fuel resource, why the HUD is hidden and the state of every module to the F8 console.

Important#

• Required resources: none. It runs standalone. OneSync is recommended. Proximity chat ranges and the replicated seatbelt and indicator states need it, and without it chat lines go to everyone.
• Detected if present: qbx_core, qb-core or es_extended; ox_core or ND_Core (for when the HUD shows); ncore_character; ncore_inventory or another supported inventory resource; one of the supported fuel resources; ncore_hud, ncore_chat, ncore_loading and the stock chat.
• Language: Config.Locale is auto. Add setr locale hu-HU to server.cfg for Hungarian, or set Config.Locale directly.
• Do not rename the ncore_vibehud folder; other nCore resources find it by that name.
• If your inventory also puts its hotbar on TAB, add setr inventory:keys ["F2","K","F3"] to server.cfg where your inventory reads that convar, or give the wheel another key.
• Players must reconnect after anything under web/ changes, because the client caches the page.

Updates are listed here, newest first. Support is on intelnpc.com.

1.0.11#

First public release.