FiveM Chat, HUD & Roleplay — Quasar Framework (qs-core) | Quasar Store

FiveM Chat, HUD & Roleplay — Quasar Framework (qs-core) | Quasar Store | Quasar Store

The chat, the roleplay commands, the HUD and the notifications are what players look at every second they spend on your FiveM server. Quasar Framework (qs-core) ships all four, styled with the same colour palette as the rest of the framework, and they work the same whether your other scripts are written for ESX, ESX Legacy or QBCore: an ESX chat:addMessage or a QBCore QBCore:Notify lands in the same chat and the same notifications.

Resource	Folder	What it does
`qs-corechat`	`[core]`	The chat box: messages, commands, suggestions. Replaces FiveM's default `chat`.

Type	Looks like	Sent by
`player`	Player name in colour, then the message	Normal chat messages
`system`	Muted grey italic text with a dot instead of a name	Server and script messages without an author
`me`	Purple italic	`/me` and `/try`
`do`	Light blue italic	`/do`
`b`	Grey-blue	`/b`
`ooc`	Grey	`/ooc`
`pm`	Yellow italic	`/pm`

Event	Supported	What is used
`chat:addMessage`	Yes	With `args = { author, text }` (two or more values): the first is the author and the second the text. With a single value in `args`, or a table with `text` and no `args`, or a plain string: a system line. `color`, `template`, `multiline` and any `args` beyond the second are ignored.
`chat:addSuggestion`	Yes	`name` (with the `/`), `help`, `params`.
`chat:addSuggestions`	Yes	A list of `{ name, help, params }`.
`chat:removeSuggestion`	Yes	`name`.
`chat:clear`, `chat:addTemplate`, `chat:addMode`, `chat:removeMode`	No	Ignored.
Server event `chatMessage`	No	Not fired: scripts that listen to `chatMessage` to read what players type do not receive normal chat messages.

lua

-- server: a line signed "System" for one player (works from ESX and QBCore scripts too)
TriggerClientEvent('chat:addMessage', source, { args = { 'System', 'Welcome to the city!' } })

-- server: a styled line straight to qs-corechat, for everyone
TriggerClientEvent('qs-corechat:client:message', -1, { text = 'Server restart in 5 minutes', type = 'system' })

Command	Syntax	Who sees it	Example output
`/me`	`/me <action>`	Players within 20 m	`* Ana Lopez opens the car door`
`/do`	`/do <description>`	Players within 20 m	`* The door is locked (( Ana Lopez ))`
`/try`	`/try <action>`	Players within 20 m	`* Ana Lopez picks the lock — and succeeds` or `— and fails` (50 / 50)
`/b`	`/b <message>`	Players within 20 m (local out of character)	`(( Ana Lopez: brb, phone call ))`
`/ooc`	`/ooc <message>`	Everyone on the server	`(OOC) Ana Lopez: anyone up for a race?`
`/pm`	`/pm <id> <message>`	The target and you	Target: `(PM from Ana Lopez): meet me at the garage` — you: `(PM to John Doe): meet me at the garage`
`/ame`	`/ame <action>`	Players within 20 m	Floating text above your head for 8 seconds, not in the chat. A new `/ame` replaces the previous one.

Message	When
You must write something	The command was sent without text.
You cannot message yourself	`/pm` with your own server ID.
That player is not online	`/pm` to a server ID that is not connected.

Option	Default	What it does
`Config.Proximity`	`20.0`	Radius in metres of `/me`, `/do`, `/try` and `/b`.
`Config.AmeDistance`	`20.0`	Radius in metres of `/ame`.
`Config.AmeDuration`	`8000`	Milliseconds the `/ame` text stays above the head.
`Config.MaxLength`	`300`	Maximum characters per message; longer text is cut.
`Config.TryOutcomes`	`{ 'success', 'fail' }`	Listed in the file, but `/try` always picks 50 / 50 between the "and succeeds" and "and fails" texts of the language file.

Element	What it shows
ID	Your server ID — what other players type in `/pm` and what admins use in commands.
ONLINE	Players online / server slots (`sv_maxclients`). Refreshed when someone joins or leaves, and every minute.
Job	Your job label ("Civilian" without one). Updates as soon as the job changes.
Cash and Bank	Your balances, updated live on every payment, paycheck or transfer.
Hunger and Thirst	Bars from 0 to 100. They flash when they drop to 20 or less.
Health	Bar from 0 to 100. Flashes at 20 or less.
Armour	Bar from 0 to 100.
Speedometer (driver only)	Speed in km/h or mph, gear (`R`, `N`, `1`, `2`...), an RPM bar whose last segments turn red, and the street name.
Fuel (driver only)	Fuel icon that turns into a warning at 20 % or less.
Seatbelt (driver only)	Seatbelt icon on the speedometer, toggled with B.

Situation	HUD
Pause menu open	Hidden, back when the menu closes.
Downed	Hidden, back when you are revived or respawn.
Character selection	Hidden until your character spawns.
Clothing editor, colour picker (`/colors`)	Hidden while open.
Menus of the framework (bank, garage, dealership, jobs, police, EMS, drugs)	Hidden while the menu is open.
Not the driver	Speedometer, fuel and seatbelt hidden.

Option	Default	What it does
`Config.UpdateInterval`	`250`	Milliseconds between status checks. The HUD only updates when a value changed.
`Config.Show.stamina`	`true`	Reads sprint stamina (breath under water). The default HUD layout does not draw a stamina bar.
`Config.Show.voice`	`true`	Reads whether you are talking, for a voice indicator. The default HUD layout does not draw a voice indicator.
`Config.HideGameText`	`true`	Hides the GTA vehicle name, area name, vehicle class and street name pop-ups.
`Config.Vehicle.unit`	`'kmh'`	`'kmh'` or `'mph'`.
`Config.Vehicle.interval`	`90`	Milliseconds between speedometer updates while driving.
`Config.Vehicle.seatbelt`	`true`	Enables the seatbelt toggle and its key.
`Config.Vehicle.beltKey`	`'B'`	Default seatbelt key.
`Config.Vehicle.fuelResource`	`'LegacyFuel'`	Fuel script to read the fuel level from. `''` = GTA's own fuel level.
`Config.Vehicle.fuelExport`	`'GetFuel'`	Export of that script that returns a vehicle's fuel.

Integration	How it works
Fuel scripts	The HUD calls `exports[fuelResource][fuelExport](vehicle)`. By default that is `LegacyFuel`, which Quasar Framework provides as a compatibility resource in `[bridge]`. For another fuel script with a fuel export (for example `ps-fuel` or `cdn-fuel` with `GetFuel`), set its resource name and export. If the script is not started or its export does not return a number, the HUD reads GTA's own fuel level, so it never breaks.
`pma-voice`	The HUD listens to `pma-voice`'s proximity changes and reads whether you are talking (`Config.Show.voice`). `pma-voice` is installed and started by the txAdmin recipe.

Integration

How it works

Fuel scripts

The HUD calls exports[fuelResource][fuelExport](vehicle). By default that is LegacyFuel, which Quasar Framework provides as a compatibility resource in [bridge]. For another fuel script with a fuel export (for example ps-fuel or cdn-fuel with GetFuel), set its resource name and export. If the script is not started or its export does not return a number, the HUD reads GTA's own fuel level, so it never breaks.

pma-voice

The HUD listens to pma-voice's proximity changes and reads whether you are talking (Config.Show.voice). pma-voice is installed and started by the txAdmin recipe.

Type	Default title	Typical use
`success`	Success	Something worked: purchase, save, paycheck.
`error`	Error	Something failed: no permission, not enough money.
`info`	Information	Neutral information. Used when no type is given.
`primary`	Notice	Announcements, such as the admin `/announce`.

Script call	Shown as
`ESX.ShowNotification(msg, type, length)` / `xPlayer.showNotification(msg)`	`info`, `success` or `error` (any other type becomes `info`).
`QBCore.Functions.Notify(text, type, length)` / `TriggerClientEvent('QBCore:Notify', ...)`	`primary`, `success` or `error`; `police`, `ambulance`, `inform` and other types become `info`.
`/announce <message>` (admins)	`primary` notification to every player for 8 seconds.

Chat, HUD & Roleplay

Chat, HUD & Roleplay

Chat (`qs-corechat`)#

Using the chat#

Message styles#

Commands and suggestions#

Server configuration#

Compatibility with ESX, QBCore and standalone chat scripts#

Roleplay commands (`qs-rp`)#

Roleplay settings (`qs-rp/config.lua`)#

HUD (`qs-corehud`)#

What the HUD shows#

Seatbelt#

When the HUD hides#

HUD settings (`qs-corehud/config.lua`)#

Fuel and voice integration#

Notifications#

Chat (qs-corechat)#