The Three Windows#

Interface has three windows, and it helps to know which is which from the start: one for every player, one for the server owner, one for chat staff.

Window	Opened with	What it is for
HUD editor	`F9` or `/hud` — every player	How their own HUD looks: styles, positions, sizes, colour, minimap shape and chat. Saved on their PC.
Interface settings	`/interfaceconfig` — the `command.interfaceconfig` ace	How the resource behaves for everyone: language, money, HUD options, 3D minimap, chat, anti-spam, stress, colours, music, commands and keys. Saved in the database.
Chat admin	`/chatadmin` — framework admins	Chat commands, word filter, 3D bubbles, job channels, tabs, VIP tags, announcements. Saved in the database.

The server sets what is allowed; each player decides how it looks. Two players on the same server can have completely different HUDs.

What Players See#

Widget	Shows	Styles
Status HUD	Health, armour, hunger, thirst, voice, stress, oxygen and stamina.	22
Vehicle HUD	Speed, RPM, gear, fuel, engine health and seatbelt; the Dashboard style adds lights, high beams, engine and lock.	11
Minimap	Circle, square, or the 3D minimap with buildings and GPS route, framed by a border theme.	3 shapes · 11 borders
Compass	Heading, street and zone, top centre, while driving.	7, including Off
Info displayer	Server ID, cash, bank, job and players online.	13
Weapon HUD	The weapon's picture, ammo in the clip and in reserve.	11
Notifications	Messages from Interface and from any script using its export.	10
Progress bar	Timed actions, with animations and props.	11
Chat	Roleplay chat with commands, tabs, VIP tags and 3D bubbles over players' heads.	11 · 8 bubble styles

The First-Time Setup#

The first time a player loads a character, a welcome screen with music opens instead of the HUD and walks them through it, one choice per screen:

Colour and HUD
The accent colour, then the status HUD style.
Notifications, progress bar and information
A style for each, then the info displayer and the weapon HUD.
Speedometer and chat
The vehicle HUD, then the chat: style, bubble style, font, size, position, timestamps and tabs.
Preview
Every widget on a sample background, ready to drag into place. ESC goes back, Enter finishes after a confirmation.

The music, its volume and the preview background are chosen in /interfaceconfig → Appearance. HUD → Skip first setup starts everyone on the default HUD instead — useful when another UI, like a multicharacter or a loading screen, would sit on top of it.

Showcase servers can make every visit start from a clean HUD so the setup always runs: add setr qs:showcase true to server.cfg.

The HUD Editor#

F9 or /hud opens the editor at any time. The minimap and every widget come on screen so they can be moved, and a slow cinematic camera circles the player (switchable in /interfaceconfig → HUD). Drag any widget to move it; ESC closes the editor and saves everything.

Tab	What you set there
Hud	Style, row or column layout, scale (0.5–2), and a switch per status to hide the ones you never want.
Notifications	Style, text alignment and scale. A sample notification shows while you choose.
Displayers	Info displayer style, weapon HUD style, scale, and which fields show: ID, cash, bank, job, players online, weapon.
Progress	Style and scale, with a looping sample.
Car Hud	Speedometer style, scale, minimap shape (circle, square or 3D), compass and map border.
Theme	The accent colour used by every widget.
Chat	Style, bubble style, font, font size, input style, scale, opacity, fade time, width, maximum messages, position (3×3 grid), timestamps and tabs — with a live preview.
Settings	Guide grid, presets, sharing a design, and resetting positions.

Presets and shared designs#

Six presets apply a complete look in one click — layout, every style, colour and chat: Clean, Dashboard, Minimal, Cyber, Racing and Tactical.

Share design → Copy code turns the whole HUD — colour, styles, scales and positions — into a code starting with QSUI1:. Another player pastes it under Import a design and presses Apply code. It is the easiest way to give a whole community the server's official look. The guide grid (small, medium or large) is drawn only while the editor is open, to line widgets up.

The editor key, the /hud and /resethud names, and the editor itself can be changed or switched off in /interfaceconfig.

The Settings Panel#

/interfaceconfig is where the server is configured, without opening a file. Sections run down the left; the search box finds a setting across all of them. Every field explains itself in the panel, and changes are only sent when you press Save — the button counts what is pending, and Discard drops it.

Saved values are written to qs_interface_settings and applied to every player at once — the language, colours and HUD options change on screen without a reconnect. A few settings are read only when the resource starts; they carry a Needs restart badge, and the panel reminds you to restart after saving one.

Reset section returns one section to the values the resource ships with; Reset everything empties the table for all of them. Both ask for confirmation and apply to everyone immediately.

General — language, money format and sounds

Setting	Default	What it does
Language	`qs:locale`, or English	One of 41 languages, for every text in game and in the panels.
Money format	Dollar	How cash and bank are written: dollar, euro, pound, real, peso (MX, AR, CO, CL), Canadian and Australian dollar, ruble, lira, złoty, rupee, yen, yuan, or a plain number.
Disable sounds	Off	Silences the clicks and effects of every menu.

HUD — editor, info shown and status icons

Setting	Default	What it does
HUD editor	On · restart	Lets players open the HUD editor with its key and command.
Skip first setup	Off	Starts new players on the default HUD instead of the welcome screen.
Cinematic editor	On	The orbiting camera while the editor is open.
Show ID · players online · job · cash · bank · weapon	All on	Removes a field from the info displayer for everyone. A removed field is greyed out in the editor with "Disabled by the server configuration".
Auto-hide statuses	Off	Status icons only appear when they need attention — see Status HUD below.

Vehicle — speed units, radar and harness

Setting	Default	What it does
Speed units	km/h	Default unit of the vehicle HUD; players can change theirs in the editor.
Radar only in vehicles	On	Hides the minimap while the player is on foot.
Harness uses	20	Hits a harness takes before it breaks (1–1000).

3D minimap — the tilted map with 3D buildings

Setting	Default	What it does
Offer the 3D minimap	On	Adds 3D to the minimap shapes of the HUD editor. Off sends anyone using it back to the square map.
Map colours	Colored	Colored is light, like the qs-pausemenu atlas map; Classic is the original GTA VI MiniMap look.
Zoom	Normal	Far, normal or close.
Zoom out with speed · with height	On · on	Shows more of the map while driving fast or flying high.
Building height	Normal	Flat, low, normal or tall.
Opacity	92%	How solid the map is drawn over the game (10–100%).
Blips	On	Draws nearby blips as coloured dots.

Chat — chat, reports, police jobs and anti-spam

Setting	Default	What it does
Chat	On	Turns the whole chat on or off.
Hide/show chat key	On · restart	Lets players cycle the chat between shown when active, always visible and hidden. Restart `qs-chat` too.
Report command	On · restart	Registers the report command. Turn it off if another resource owns it.
3D bubbles	On	Master switch of the speech bubbles. Off removes them from the editor and from `/chatadmin`.
Police jobs	police, sherif	Jobs that count as law enforcement: they cannot use or read `/anon`. Type a job and press Enter to add it.
Anti-spam	On	Blocks players for a moment when they send messages too fast.
Anti-spam level	Normal	Relaxed, normal or strict — see Protection below.
Admins skip anti-spam	On	Admins are never blocked.

Stress — stress from shooting and speeding

Setting	Default	What it does
Stress	Off · restart	Players gain stress from shooting and speeding, with screen effects.
Chance when shooting	10%	Chance of gaining stress on each shot.
Effects from	50	Stress level at which the screen effects start.
Speed with seatbelt · without	100 · 50	Driving faster than this causes stress, in the units of the Vehicle section.
Jobs without stress	police, ambulance	Jobs that never gain stress.

Appearance — main colour, preview screen and music

Setting	Default	What it does
Main colour	`#00b2ff`	The accent of the HUD, the vehicle HUD, the menus and the chat.
Preview background	A city screenshot	Image URL behind the HUD on the preview step. Use a direct, stable link.
Welcome music	Action Stylish	Action Stylish, Metal Dark, Powerful Epic, Steel Bars, or Random.
Music volume	30%	Volume of the welcome screen music.

Commands and keys — every name and default key

All of these need a restart. Command names are typed without the slash.

Setting	Default	What it does
HUD editor key	F9	F1–F12, Home, End, Insert, Delete, Page Up or Page Down.
HUD command	`hud`	Opens the editor, like its key. Empty removes it.
Reset HUD command	`resethud`	Puts every widget back in its default spot. Empty removes it.
Hide/show chat key	L	Default key that cycles the chat's visibility.
Report command name	`report`	Name of the report command.
Settings command	`interfaceconfig`	The command that opens this panel. The ace stays `command.interfaceconfig`.

A new default key only reaches players who never changed it: FiveM keeps each player's own binding.

Status HUD#

Health and armour come from the game; hunger and thirst from esx_status on ESX or player metadata on QBCore; stamina and oxygen from the player; voice from your voice resource — its ring grows with the current voice range.

The 22 styles: Hexagon (default), Dashboard, Basic, Modern, Diamond, Skew, Circle, Icon + Percentage, Pill, Neon Ring, Shield, Wave, Arc, Minimal Bar, Octagon, Rounded Square, Futuristic, Tech Ring, Blade, Reactor, Glitch Bar and Cyber. Dashboard is a wide panel docked under the minimap, sized to its width.

With Auto-hide statuses on, a status only appears when it needs attention:

Status	Shown when
Health, hunger, thirst, stamina	50% or below
Stress	50% or above
Oxygen	As soon as the player starts using air underwater
Armour, voice	Always

Everything shows while the editor is open, so it can still be moved.

Vehicle HUD, Minimap and Compass#

Getting into a vehicle brings up the speedometer, the minimap and the compass. The 11 speedometer styles: Advanced (default), Dashboard, Basic, Modern, Minimal, Racing, Cockpit, Futuristic, GT Race, Apex and Cyber.

Piece	Options
Minimap shape	Square (default), Circle, or 3D. Square and circle reshape the game's own radar; 3D is drawn by Interface.
Map border	Holo (default), Dashboard, None, Futuristic, Neon, Minimal, Tactical, Chrome, Carbon, Overload, Cyber. Dashboard adds a row with the in-game clock, weather, wind and altitude.
Compass	Arc (default), Ruler, Badge, Minimal, Cyber, Tactical, or Off. Shows the heading, the street and the zone.

The 3D Minimap#

Picking 3D under Car Hud → Minimap Shape replaces the radar with a tilted map of the whole city: every building in 3D, roads, paths, water and sand, turning with the camera. It is drawn by the Interface, so it looks the same at any resolution.

The GPS route — pink to a waypoint, yellow for a mission route — runs under the buildings and stays faintly visible behind tall ones. The distance left is written in the corner, in km or miles following the player's speed unit, and a marker shows the destination once it is on the map.
Blips within 600 metres appear as dots in their own colour — shops, garages and anything your scripts add.
Buildings fade around the player so the pointer is never hidden, and a north badge sits on the frame's edge.
The view pulls back at speed and in the air, when those settings are on.

Its colours, zoom, building height, opacity and blips are server settings in /interfaceconfig → 3D minimap. Other scripts that hide or show the radar keep working — the game radar stays on, just off screen. If a player's game cannot draw it, they get the square map back for that session and the console says why.

Info Displayer and Weapon HUD#

The info displayer shows the player's server ID, cash, bank, job and the number of players online out of sv_maxclients. Money follows the Money format of the settings panel. Any field can be removed for everyone in /interfaceconfig → HUD; players can also hide fields for themselves in the editor.

The weapon HUD appears while a weapon is drawn, with its picture and ammo. Every GTA V weapon has its own picture; an addon weapon shows a generic one.

Notifications and Progress Bar#

Both are drawn by Interface for any script that calls them — see Commands and Exports. Notifications come in 10 styles (Modern, Basic, Classic, Minimal, Neon, Toast, Gradient, Banner, Futuristic, Cyber); the progress bar in 11 (Skew, Basic, Classic, Circle, Wave, Gradient, Minimal, Retro, Ring, Futuristic, Cyber).

A progress bar can play an animation or scenario, attach props every nearby player sees, and lock movement, sprint, driving, combat or the camera. It stops by itself if the player dies, ragdolls, falls, swims or is cuffed — unless the script allows it — and X cancels it when it is cancellable.

Seatbelt#

B buckles and unbuckles, with a notification and the seatbelt icon on the vehicle HUD. Motorcycles, bicycles and boats have no seatbelt. While buckled the player cannot leave the vehicle.

Without it, a hard crash above roughly 110 km/h can throw the player through the windscreen, hurting them in proportion to the speed. Heavy crashes also stall the engine. When InteractSound is installed, nearby players hear the buckle.

Stress#

The stress system ships off; switch it on in /interfaceconfig → Stress and restart the resource. It then rises from:

Speeding — above the buckled or unbuckled speed limit of the panel, checked every 10 seconds.
Shooting — each shot has the panel's chance to add some. Jerry cans, hazard cans and extinguishers never count.
Other scripts — through the same events qb-hud uses, see Integrations.

Jobs without stress (police and ambulance by default) never gain it. From the Effects from level (50) the screen blurs now and then — stronger and more often as it climbs — and at 100 the player also stumbles and blacks out briefly.

Eating, drinking, healing and dying relieve it automatically on both frameworks. Stress is saved per character: in users.stress on ESX and in metadata on QBCore.

The Chat#

T opens the chat. Suggestions appear as you type a command, with its parameters; Tab completes, ↑ ↓ browse what you sent before, and Ctrl + Tab switches channel. The input has an emoji picker and two buttons that roll a die or play rock-paper-scissors. Messages support ^0–^9 colours, clickable links and @mentions, which play a sound to the person mentioned.

L cycles the chat between Show when active (it fades after a few seconds), Always visible and Hidden. Players can rebind it in Settings → Key Bindings → FiveM.

Roleplay commands#

Command	Who reads it
`/me <action>`	Players within 20 metres.
`/do <description>`	Players within 20 metres.
`/ooc <message>`	Everyone — or only players nearby with OOC proximity on.
`/anon <message>`	Everyone except the police jobs, signed ANONYMOUS. Police cannot use it.
`/pm <id> <message>`	Only that player.
`/report <message>`	Every admin online, plus a copy for the sender.
`/a <message>`	Only admins can send it; everyone sees it as an admin message.
Dice · Rock-paper-scissors	Buttons in the chat input; the result goes to players within 20 metres.
Job channels	Commands you create in `/chatadmin`, read only by one job from a minimum grade.

Typing without a command is blocked by default; /chatadmin → Actions → Plain global chat turns it into a global message.

Protection#

The anti-spam has three levels, picked in /interfaceconfig → Chat:

Level	Blocked after	Block	Fastest message
Relaxed	20 messages in 10 s	3 s	0.1 s apart
Normal	12 messages in 10 s	5 s	0.2 s apart
Strict	6 messages in 10 s	10 s	0.5 s apart

Players are warned before they are blocked; faster messages are simply dropped. The word filter, in /chatadmin, replaces blocked words with * characters and sees through repeated letters ("fuuuck") and leetspeak ("5h1t").

3D bubbles#

Messages can float above the speaker's head for nearby players — up to four stacked, shrinking and fading with distance. With the master switch on in /interfaceconfig → Chat, staff turn them on and pick the commands, time, cooldown and range in /chatadmin → 3D Bubbles. Each player picks the look in the editor: Classic, Stripe, Legend, Minimal, Outline, Futuristic, Cyber or Racing.

The Chat Admin Panel#

/chatadmin opens it for admins. Everything here is saved to the database and applied to every player at once — no restart.

Tab	What it holds
Commands	Enable or disable /me, /do, /ooc, /anon, /a, /report, dice, rock-paper-scissors and /pm, and give each a colour and icon.
Bad Words	The filter switch, warn sender, leetspeak detection, the replacement character and the word list.
3D Bubbles	Which commands show bubbles, time, cooldown, range, scale and opacity. Hidden when the master switch is off.
Job Channels	Private channels per job: a command (e.g. `/pd`), a label, the job, a minimum grade, colour and icon. Members also get a chat tab for it.
Category Tabs	The tabs under the chat input — ME, DO, OOC, ANON, PM — with their names and colours, or none at all.
VIP Tags	Grant, edit and remove VIP tags, online or offline, and filter the list by tier and status.
Actions	Plain global chat, OOC proximity, clear the chat for everyone, and send an announcement.

Every save, clear and announcement is logged to Discord when a webhook is set.

VIP Chat Tags#

A VIP tag puts a badge before the player's name and colours it, in the chat and in their 3D bubbles. Tags belong to the Rockstar license, so they follow the player across characters.

Tier	Look
`vip`	Gold, still.
`premium`	Cyan to blue, shimmering.
`elite`	Purple, pulsing.
`legend`	Gold and orange, moving gradient.
`immortal`	Red and gold, rainbow animation.

Four ways to hand one out:

The VIP Tags tab of /chatadmin — search any character, online or not, and choose permanent or until a date.
/givevip <id> <tier> [days] in game or in the server console; no days means permanent.
/redeemvip <tbx-id> <tier> — the player redeems a Tebex purchase themselves. Each transaction works once.
Your own store or bot writes chat_vip_tags and calls refreshVip — see Integrations.

Expired tags are removed on their own. /removevip <id> takes one away.

Where Everything Is Saved#

What	Where	Changed by
HUD layout, styles, colour, minimap shape, chat look	The player's game client	Each player, in the setup and the editor
Language, money, HUD options, 3D minimap, chat rules, stress, appearance, commands	`qs_interface_settings`	The owner, in /interfaceconfig
Chat commands, filter, bubbles, job channels, tabs	`chat_admin_settings`	Admins, in /chatadmin
VIP tags	`chat_vip_tags`	Admins, commands, Tebex, your scripts
Debug and resource detection	`config/config.lua`	You, with a restart

Nothing in the database is touched by an update. To start again from the shipped defaults, use Reset everything in /interfaceconfig.

The Three Windows#

What Players See#

The First-Time Setup#

Colour and HUD

Notifications, progress bar and information

Speedometer and chat

Preview

The HUD Editor#

Presets and shared designs#

The Settings Panel#

Status HUD#

Vehicle HUD, Minimap and Compass#

The 3D Minimap#

Info Displayer and Weapon HUD#

Notifications and Progress Bar#

Seatbelt#

Stress#

The Chat#

Roleplay commands#

Protection#

3D bubbles#

The Chat Admin Panel#

VIP Chat Tags#

Where Everything Is Saved#

The Three Windows#

What Players See#

The First-Time Setup#

Colour and HUD

Notifications, progress bar and information

Speedometer and chat

Preview

The HUD Editor#

Presets and shared designs#

The Settings Panel#

Status HUD#

Vehicle HUD, Minimap and Compass#

The 3D Minimap#

Info Displayer and Weapon HUD#

Notifications and Progress Bar#

Seatbelt#

Stress#

The Chat#

Roleplay commands#

Protection#

3D bubbles#

The Chat Admin Panel#

VIP Chat Tags#

Where Everything Is Saved#

The Three Windows#

What Players See#

The First-Time Setup#

Colour and HUD

Notifications, progress bar and information

Speedometer and chat

Preview

The HUD Editor#

Presets and shared designs#

The Settings Panel#

Status HUD#

Vehicle HUD, Minimap and Compass#

The 3D Minimap#

Info Displayer and Weapon HUD#

Notifications and Progress Bar#

Seatbelt#

Stress#

The Chat#

Roleplay commands#

Protection#

3D bubbles#

The Chat Admin Panel#

VIP Chat Tags#

Where Everything Is Saved#

The Three Windows#

What Players See#

The First-Time Setup#

Colour and HUD

Notifications, progress bar and information

Speedometer and chat

Preview

The HUD Editor#