Quasar Framework (qs-core) works with the tools a FiveM roleplay server already runs: txAdmin, oxmysql, ox_lib, pma-voice, Quasar Store's advanced inventory and the fuel, target, progress bar and vehicle key resources that ESX and QBCore scripts expect. This page lists every integration, how Quasar Framework detects it and the setting that controls it.

Most of it needs nothing from you. The txAdmin recipe installs the dependencies at tested versions, and the integrations switch on by themselves when the resource they talk to is started.

Overview#

Integration	Needed?	Installed by the txAdmin recipe
txAdmin	Recommended — one-click install, admin rights, Heal revives	—
oxmysql	Required by `qs-core`	Yes, `2.14.3` in `[standalone]`
ox_lib	Only for third-party scripts that use it	Yes, `3.39.0` in `[standalone]`
pma-voice	Recommended — proximity voice and the HUD voice indicator	Yes, `6.6.2` in `[standalone]`
Quasar Store advanced inventory (`qs-inventory`)	Optional, replaces `qs-coreinventory`	No (separate Quasar Store product)
Fuel (`LegacyFuel` bridge)	Included	Yes, in `[bridge]`
Target, menu and input libraries	Only for third-party scripts that use them	No
Progress bars (`progressbar` bridge)	Included	Yes, in `[bridge]`
Vehicle keys (`qb-vehiclekeys` bridge)	Included	Yes, in `[bridge]`
Society funds (`esx_society`, `qb-management` bridges)	Included	Yes, in `[bridge]`
Maps: `bob74_ipl`, `hospital_map`	`hospital_map` is needed by `qs-ambulance`	Yes, `bob74_ipl 2.7.1` and the Pillbox interior in `[maps]`
`mapmanager`, `spawnmanager`	Included	Yes, in `[cfx-default]`
Discord webhooks	Optional	Settings in the config files

txAdmin#

Quasar Framework installs from txAdmin with a recipe and listens to txAdmin's Heal action. In txAdmin → Setup → Server Deployer, choose Remote URL Template and paste:

bash

https://raw.githubusercontent.com/imnotquasar/qs-core/main/qs-recipes/recipe.yaml

Feature	Detected from	What it changes	Setting
One-click install	The recipe URL above	Imports the database (`qscore.sql`), writes a commented `server.cfg`, and downloads `[core]`, `[addons]`, `[bridge]`, oxmysql, ox_lib, pma-voice, bob74_ipl, the Pillbox hospital interior, `mapmanager` and `spawnmanager`. Third-party downloads are pinned to tested versions.	—
Admin rights	txAdmin adds your identifier to `group.admin` in `server.cfg`	`add_ace group.admin command allow` gives `group.admin` the `command.qs` permission, so you can use the admin commands and open the admin menu with F6 as soon as you join.	`server.cfg` — add more admins with `add_principal identifier.fivem:<id> group.admin`
Heal	txAdmin's `txAdmin:events:healedPlayer` event	Heal on a player revives them from the downed state; Heal all revives every player with a loaded character.	—
Spawn vehicle	Not hooked	The car has no keys, so `qs-corevehiclekeys` keeps its engine off for you. Spawn with `/car <model>` or the F6 menu instead (both give keys), or sit in the car and run `/adminkeys`.	`Config.RequireKeysToDrive` in `[core]/qs-corevehiclekeys/config.lua`
Bans	Not hooked	Bans made in txAdmin are kept and enforced by txAdmin. Bans made with `/ban` or the F6 menu are kept in Quasar Framework's `bans` table and checked when a player connects. The two lists are separate.	`Config.EnableBans` in `[core]/qs-core/shared/config.lua`

The full installation walkthrough is in Installation; admin rights, groups and bans are in Administration.

Quasar Store advanced inventory (qs-inventory)#

Quasar Framework ships its own inventory, qs-coreinventory. If you own Quasar Store's advanced inventory, qs-inventory, you can run it instead — every item operation of Quasar Framework, and of the ESX and QBCore bridges, then goes through it.

Part	Detected from	What it changes	Setting
Quasar Framework core	`qs-coreinventory` is not started and `qs-inventory` is started	Items given, removed and checked by Quasar Framework (`AddItem`, `RemoveItem`, `HasItem`, usable items...) are routed to `qs-inventory`.	`Config.Inventory` in `[core]/qs-core/shared/config.lua` — leave it on `'auto'`
ESX bridge (`es_extended`)	The `qs-inventory` resource is present on the server	Switches by itself: `xPlayer` inventory, items, accounts and `ESX.RegisterUsableItem` go to `qs-inventory`, and account changes are written back to the character's cash and bank.	Automatic
QBCore bridge (`qb-core`)	`qs-inventory` is started before `qb-core`	Usable items registered by QBCore scripts are kept by the bridge for `qs-inventory` to look up (export `GetUsableItems`) instead of being registered in Quasar Framework.	Start order in `server.cfg`

Install qs-inventory
Install qs-inventory as its own documentation describes (items, images and its own settings).
Replace the inventory in server.cfg
Replace the ensure qs-coreinventory line with ensure qs-inventory, in the same place — after qs-core and before ensure [bridge]:
bash
```
ensure qs-core
ensure qs-inventory
ensure qs-clothing
```
Leave the core setting on auto
Keep Config.Inventory = 'auto' in [core]/qs-core/shared/config.lua.
Restart the server
Restart (not just the resource) so every resource picks the new inventory up.

ox_lib#

Detected from	What it changes	Setting
Nothing — Quasar Framework does not use ox_lib.	The recipe installs ox_lib `3.39.0` and starts it before `qs-core`, so third-party scripts that include `@ox_lib/init.lua` find it ready. Scripts that use ox_lib's own UI (`lib.notify`, `lib.progressBar`, `lib.registerContext`...) show ox_lib's interface, not Quasar Framework's.	`ensure ox_lib` in `server.cfg`

Keep it: a large share of ESX and QBCore scripts list ox_lib as a dependency. Remove it only if none of your scripts needs it.

oxmysql#

Detected from	What it changes	Setting
`qs-core` declares it as a dependency, and the resources that use the database load `@oxmysql/lib/MySQL.lua`.	All database access. The recipe imports Quasar Framework's tables; the bridges create `users`, `owned_vehicles`, `society_accounts` and `management_funds` on their own when they start.	`set mysql_connection_string "..."` in `server.cfg` (filled in by txAdmin) and `ensure oxmysql` before `qs-core`

Third-party scripts that use oxmysql (MySQL.query, MySQL.insert, exports.oxmysql...) share the same connection. The tables are described in ESX & QBCore Compatibility.

pma-voice#

The recipe installs pma-voice 6.6.2 and starts it before qs-core.

Feature	Detected from	What it changes	Setting
Voice settings	Convars in `server.cfg`	`setr voice_enableRadioAnim 1`, `setr voice_useNativeAudio true` and `setr voice_useSendingRangeOnly true` configure pma-voice itself.	`server.cfg` (see pma-voice's own documentation for every convar)
HUD talking indicator	GTA's talking state	The HUD voice icon lights up while you speak.	`Config.Show.voice` in `[core]/qs-corehud/config.lua` (default `true`)
HUD voice range	pma-voice's `pma-voice:setTalkingMode` event	When you cycle your voice range with pma-voice, the HUD shows the new mode.	—

Fuel#

[bridge]/LegacyFuel is a LegacyFuel-compatible fuel resource. Scripts that call exports['LegacyFuel']:GetFuel(vehicle) or SetFuel(vehicle, fuel) work as they are.

Feature	Detected from	What it changes	Setting
Fuel consumption	You drive a vehicle	Fuel drops once a second while the engine runs, faster at high RPM; at 0 the engine stops. A vehicle without a fuel value starts from its current GTA fuel level (or a random 45–85 if that is empty).	Tunables at the top of `[bridge]/LegacyFuel/client.lua` (`tick`, `idleUse`, `driveUse`)
HUD fuel gauge	The resource named in the HUD config is started	The speedometer reads fuel from that resource's export; if it is not started, the HUD reads GTA's own fuel level.	`Config.Vehicle.fuelResource = 'LegacyFuel'` and `Config.Vehicle.fuelExport = 'GetFuel'` in `[core]/qs-corehud/config.lua`
Garages	—	`qs-garage` saves a car's fuel level when you store it and restores it when you take it out; the dealership registers new cars with a full tank.	—

To use a different fuel script, point Config.Vehicle.fuelResource and Config.Vehicle.fuelExport at its resource name and its getter export (one that takes the vehicle and returns a number). Stop the LegacyFuel bridge at the same time so fuel is not consumed twice — unless your scripts still call exports['LegacyFuel'], in which case pick a fuel script that answers under that name.

Quasar Framework's own resources do not need a target or menu library. Third-party scripts often do; install them as they are, the same way you would on ESX or QBCore, and ensure them after [bridge]:

Library	Typical users	Notes
`ox_target`	ESX and QBCore scripts	Install as is.
`qb-target` + `PolyZone`	QBCore scripts	Install both, as on QBCore.
`qb-menu`, `qb-input`	QBCore scripts	Install as is.
`esx_menu_default` (or another ESX menu)	ESX scripts that use `ESX.UI.Menu`	Registers the menu type that `ESX.UI.Menu.Open` needs.
`ox_lib` context menus and inputs	Scripts built on ox_lib	Already installed (see ox_lib above).

Progress bars#

Called through	Detected from	What it changes
`exports['progressbar']:Progress(data, handler)` and the other `progressbar` exports	`[bridge]/progressbar`	Drawn with Quasar Framework's progress bar, with the animation, props and movement lock from `data`.
`QBCore.Functions.Progressbar(...)`	`qb-core` bridge	Same progress bar, with the animation and one prop.
`ESX.Progressbar(message, length, options)`	`es_extended` bridge	Same progress bar.
`exports['qs-core']:Progress(data)`	Quasar Framework	The progress bar itself.

A cancellable progress bar is cancelled with X. Scripts that use ox_lib's lib.progressBar show ox_lib's own bar.

Vehicle keys#

Called through	Detected from	What it changes	Setting
`qb-vehiclekeys` exports and events (`GiveKeys`, `HasKeys`, `vehiclekeys:client:SetOwner`...)	`[bridge]/qb-vehiclekeys`	Forwarded to `qs-corevehiclekeys` when it is started, so keys from QBCore scripts lock and unlock the car (U) and let you drive it. Without `qs-corevehiclekeys`, the bridge keeps a simple key list of its own.	—
Built-in resources	`qs-corevehiclekeys` is started	`/car`, the F6 menu's vehicle spawn, the garages and the dealership give you keys to the car.	`[core]/qs-corevehiclekeys/config.lua`

Keys, locks and hotwiring are explained in Vehicles.

Society and job funds#

Bridge	Used by	Stored in	Notes
`esx_society`	ESX scripts that pay into or read society accounts	`society_accounts`	Exports `getSociety`, `getSocietyMoney`, `addMoney`, `removeMoney`; no boss menu.
`qb-management`	QBCore scripts that pay into or read job and gang funds	`management_funds`	Exports `GetAccount`, `AddMoney`, `RemoveMoney`, `GetGangAccount`, `AddGangMoney`, `RemoveGangMoney`; no boss menu.

The two are separate stores: money an ESX script puts in a society account is not visible in the qb-management fund of the same job. Quasar Framework's built-in resources do not use either, and paychecks are paid straight to each player's bank.

Maps#

Resource	Folder	Why it is there
`bob74_ipl` 2.7.1	`[maps]`	Loads GTA Online interiors and map details (IPLs).
`hospital_map`	`[maps]`	The Pillbox Hill hospital interior. `qs-ambulance` places its default hospital ped, supply cabinet and EMS garage in and beside it — without it those points stand in an empty shell.

Both are started by ensure [maps] in server.cfg, before [bridge]. Add your own maps to the same folder.

FiveM default resources#

Resource or setting	What it does with Quasar Framework	Setting
`mapmanager`, `spawnmanager`	Installed from cfx-server-data into `[cfx-default]`.	`ensure mapmanager` and `ensure spawnmanager` in `server.cfg`
`basic-gamemode`	Do not add it. Its automatic respawn fights Quasar Framework's downed state.	—
FiveM's built-in `chat`	Replaced by `qs-corechat`, which answers `chat:addMessage`, `chat:addSuggestion`, `chat:addSuggestions` and `chat:removeSuggestion`, so scripts that post to the chat keep working.	`set resources_useSystemChat false` in `server.cfg`

Discord webhooks#

Logs are off until you paste a webhook URL. Each setting takes a Discord webhook URL; '' keeps it off.

Setting	File	What is posted
`Config.Webhooks.money`	`[core]/qs-core/shared/config.lua`	Cash handed over with `/givemoney`.
`Config.Webhooks.admin`	`[core]/qs-core/shared/config.lua`	`/setjob`, `/addmoney`, `/removemoney`, `/kick`, and every ban made with `/ban` or the `AddBan` / `ExploitBan` exports.
`Config.Webhooks.connections`	`[core]/qs-core/shared/config.lua`	Present in the file; nothing is posted to it in this version.
`Config.Webhook`	`[addons]/qs-admin/config.lua`	Every action taken from the admin menu (F6) except Go to and Spectate, as one line: admin, action, target and detail.

lua

-- [core]/qs-core/shared/config.lua
Config.Webhooks = {
    money       = 'https://discord.com/api/webhooks/...',
    admin       = 'https://discord.com/api/webhooks/...',
    connections = '',
}

Building an integration of your own? Quasar Framework's exports and events — inventory, money, jobs, notifications, progress bar — are listed in Commands and Exports.

Frequently asked questions#

Do I need ox_lib for Quasar Framework?

No. Quasar Framework does not use it. The recipe installs it because many ESX and QBCore scripts list it as a dependency.

Can I use Quasar Store's qs-inventory with Quasar Framework?

Yes. Replace ensure qs-coreinventory with ensure qs-inventory in server.cfg; Quasar Framework and both bridges route items through it. Do not run both inventories at once.

Does Heal in the txAdmin menu revive downed players?

Yes. txAdmin's Heal revives the player from the downed state, and Heal all revives every player with a loaded character.

Which fuel script does the HUD read?

LegacyFuel by default — the compatible fuel resource in [bridge]. Change Config.Vehicle.fuelResource and Config.Vehicle.fuelExport in [core]/qs-corehud/config.lua to read another script's fuel export.

Do I need qb-target or ox_target?

Not for Quasar Framework itself. Install the target library a third-party script asks for, as it is, and start it after [bridge].

Why does the hospital look empty?

hospital_map is not running. Make sure it is in [maps] and that ensure [maps] is in server.cfg.

Overview#

txAdmin#

Quasar Store advanced inventory (qs-inventory)#

Install qs-inventory

Replace the inventory in server.cfg

Leave the core setting on auto

Restart the server

ox_lib#

oxmysql#

pma-voice#

Fuel#

Target, menu and input libraries#

Progress bars#

Vehicle keys#

Society and job funds#

Maps#

FiveM default resources#

Discord webhooks#

Frequently asked questions#

Overview#

txAdmin#

Quasar Store advanced inventory (qs-inventory)#

Install qs-inventory

Replace the inventory in server.cfg

Leave the core setting on auto

Restart the server

ox_lib#

oxmysql#

pma-voice#

Fuel#

Target, menu and input libraries#

Progress bars#

Vehicle keys#

Society and job funds#

Maps#

FiveM default resources#

Discord webhooks#

Frequently asked questions#

Overview#

txAdmin#

Quasar Store advanced inventory (qs-inventory)#

Install qs-inventory

Replace the inventory in server.cfg

Leave the core setting on auto

Restart the server

ox_lib#

oxmysql#

pma-voice#

Fuel#

Target, menu and input libraries#

Progress bars#

Vehicle keys#

Society and job funds#

Maps#

FiveM default resources#

Discord webhooks#

Frequently asked questions#

Overview#

txAdmin#

Quasar Store advanced inventory (qs-inventory)#

Install qs-inventory

Replace the inventory in server.cfg

Leave the core setting on auto

Restart the server

ox_lib#

oxmysql#

pma-voice#

Fuel#

Target, menu and input libraries#

Progress bars#

Vehicle keys#

Society and job funds#

Maps#

FiveM default resources#

Discord webhooks#

Frequently asked questions#