FiveM Framework Configuration — Quasar Framework (qs-core) | Quasar Store

FiveM Framework Configuration — Quasar Framework (qs-core) | Quasar Store | Quasar Store

Everything a server owner changes in Quasar Framework (qs-core) lives in plain Lua config files and in server.cfg. This page is the complete reference for this FiveM roleplay framework: every option of the core config, the theme colours, languages, items, jobs and gangs, the inventory and weapon settings, and the loading screen. Each section lists the option, its default value and what it changes in game, followed by a short example.

File	What it configures
`[core]/qs-core/shared/config.lua`

Option	Default	What it does
`Config.Accounts`	`{ cash = 500, bank = 5000, black_money = 0 }`	The money accounts every character has, and the balance a new character starts with. An account that is missing on an existing character is added with this starting balance when the character loads. Money commands and exports only work with accounts listed here.

Option	Default	What it does
`Config.MaxCharacters`	`5`	How many characters one player can create. Character creation is refused once the limit is reached.
`Config.DefaultSpawn`	`vec4(-268.4842, -957.7139, 31.2231, 205.8032)`	Where a new character appears for the first time (x, y, z, heading). Afterwards each character spawns where it last was.
`Config.DefaultJob`	`'unemployed'`	The job given to every new character. It must exist in `shared/jobs.lua`.
`Config.DefaultJobGrade`	`0`	The grade of that default job.
`Config.SaveInterval`	`5 * 60 * 1000`	How often (in milliseconds) every online character is saved. Characters are also saved when the player disconnects, logs out and when `qs-core` stops.
`Config.Debug`	`true`	Prints debug lines in the console, prefixed `[qs-core:server]` / `[qs-core:client]` (for example the number of players saved by each autosave). Set it to `false` on a live server for a quieter console.

lua

Config.MaxCharacters = 3

-- New characters start at the airport
Config.DefaultSpawn = vec4(-1037.74, -2737.84, 20.17, 330.0)

-- Autosave every 10 minutes
Config.SaveInterval = 10 * 60 * 1000
Config.Debug = false

Option	Default	What it does
`Config.Paycheck.enabled`	`true`	Turns paychecks on or off. Read once when `qs-core` starts.
`Config.Paycheck.interval`	`30 * 60 * 1000`	Time between paychecks, in milliseconds.

Option	Default	What it does
`Config.Death.respawnTime`	`20`	Seconds a downed player must wait before E respawns them at the nearest hospital.
`Config.Death.loseCashOnDeath`	`false`	When `true`, the player's `cash` is set to 0 when they respawn at a hospital.
`Config.Death.emsCooldown`	`30000`	Cooldown in milliseconds between two G calls to paramedics.
`Config.Death.anim`	`{ dict = 'mini@cpr@char_b@cpr_def', clip = 'cpr_pumpchest_idle' }`	The animation a downed player lies in.
`Config.Death.hospitals`	`vec4(298.6, -584.6, 43.26, 65.0)`, `vec4(-247.6, 6331.4, 32.4, 200.0)`	Respawn points (x, y, z, heading). The nearest one to where the player went down is used.

lua

Config.Death = {
    respawnTime = 60,          -- one minute to wait for EMS
    loseCashOnDeath = true,
    emsCooldown = 60000,
    anim = { dict = 'mini@cpr@char_b@cpr_def', clip = 'cpr_pumpchest_idle' },
    hospitals = {
        vec4(298.6, -584.6, 43.26, 65.0),    -- Pillbox Hill
        vec4(-247.6, 6331.4, 32.4, 200.0),   -- Paleto Bay
        vec4(1839.6, 3672.9, 34.28, 210.0),  -- add Sandy Shores
    },
}

Option	Default	What it does
`Config.DisableWanted`	`true`	Removes GTA's wanted level: players never get wanted stars.
`Config.DisableDispatch`	`true`	Turns off GTA's emergency dispatch, so NPC police, ambulances and fire trucks are not sent to players.
`Config.EnablePvP`	`true`	Keeps friendly fire on, so players can damage each other. `false` stops forcing it on but does not actively block PvP.
`Config.DisableRain`	`true`	Keeps the weather dry: whenever the weather is about to turn to rain, thunder or clearing, it changes to clouds instead.
`Config.DisablePeds`	`false`	Removes ambient pedestrians from the streets.
`Config.DisableTraffic`	`false`	Removes NPC traffic and parked cars, plus garbage trucks, random boats and trains.

Option	Default	What it does
`Config.Webhooks.money`	`''`	Discord webhook URL for money logs (`/givemoney`). `''` turns it off.
`Config.Webhooks.admin`	`''`	Discord webhook URL for admin logs: `/setjob`, `/addmoney`, `/removemoney`, `/kick` and bans. `''` turns it off.
`Config.Webhooks.connections`	`''`	Reserved: nothing is posted to this channel in the current version.
`Config.EnableBans`	`true`	Checks the `bans` table when a player connects and rejects banned players with the ban reason. With `false`, bans are not enforced on connect.

lua

Config.Webhooks = {
    money       = 'https://discord.com/api/webhooks/XXXXXXXX/money-channel',
    admin       = 'https://discord.com/api/webhooks/XXXXXXXX/admin-channel',
    connections = '',
}

Config.EnableBans = true

Option	Default	What it does
`Config.Inventory`	`'auto'`	Which inventory `qs-core` routes item calls to. Leave it on `'auto'`: `qs-coreinventory` is used whenever it is started; when it is not and Quasar Store's advanced `qs-inventory` is running, items go to `qs-inventory`.

Option	Default	What it does
`Config.Identifier`	`'license'`	The identifier type that links a player to their characters and saved colour palette. Do not change it on a live server: existing characters are stored under the current identifier and would no longer be found. Bans and groups always use the Rockstar `license`.
`Config.Locale`	`'en'`	Fallback language for `qs-core` when the `qs:locale` convar is not set. Set the language with `setr qs:locale` in `server.cfg` instead (see Languages below).

Key	Default	What it colours
`name`	`'blue'`	The palette name.
`text`	`'#eaf2ff'`	Main text.
`muted`	`'#8ea6cc'`	Secondary, muted text.
`primary`	`'#3b82f6'`	The primary colour.
`primaryDim`	`'#2563eb'`	A darker shade of the primary colour.
`accent`	`'#5cbaf0'`	The accent colour.
`gradientFrom`	`'rgba(59, 146, 246, 0.60)'`	Gradient start.
`gradientTo`	`'rgba(37, 99, 235, 0.30)'`	Gradient end.
`glow`	`'rgba(59, 130, 246, 0.45)'`	Glow effects.
`border`	`'rgba(96, 165, 250, 0.45)'`	Borders.
`panel`	`'rgba(20, 40, 78, 0.32)'`	Panel backgrounds.
`health`	`'#5cf07c'`	Health status bar.
`armor`	`'#3b82f6'`	Armour status bar.
`hunger`	`'#f0a83a'`	Hunger status bar.
`thirst`	`'#24c8d8'`	Thirst status bar.

lua

-- A red server theme
Config.Theme = {
    name         = 'red',
    text         = '#fff1f1',
    muted        = '#cc8e8e',
    primary      = '#ef4444',
    primaryDim   = '#dc2626',
    accent       = '#f87171',
    gradientFrom = 'rgba(239, 68, 68, 0.60)',
    gradientTo   = 'rgba(220, 38, 38, 0.30)',
    glow         = 'rgba(239, 68, 68, 0.45)',
    border       = 'rgba(248, 113, 113, 0.45)',
    panel        = 'rgba(78, 20, 20, 0.32)',
    health       = '#5cf07c',
    armor        = '#3b82f6',
    hunger       = '#f0a83a',
    thirst       = '#24c8d8',
}

Option	Default	What it does
`Config.AllowColorChange`	`true`	Registers the colour picker command. With `false`, players cannot change their colours with a command.
`Config.ColorCommand`	`'colors'`	The name of that command (`/colors` by default).

Copy the English file
In each resource, copy locales/en.lua to locales/<code>.lua — for example locales/nl.lua for Dutch.

Rename the table and translate

Change Locales.en to Locales.nl and translate every value. Keep the keys exactly as they are, and keep placeholders such as %s and %d: they are replaced by names and amounts.

lua

Locales = Locales or {}

Locales.nl = {
    no_permission    = 'Geen toestemming.',
    player_not_found = 'Speler niet gevonden.',
    invalid_amount   = 'Ongeldig bedrag.',
    paycheck         = 'Salaris ontvangen: $%d',
    -- ...every other key from en.lua
}

Switch the server to it
Set setr qs:locale "nl" in server.cfg and restart the server.

Item	Label	Weight (g)	Usable
`water`	Water Bottle	500	Yes
`bread`	Bread	300	Yes
`bandage`	Bandage	100	Yes
`phone`	Phone	190	Yes
`id_card`	ID Card	10	No
`weapon_pistol`	Pistol	1000	Yes
`lockpick`	Lockpick	100	Yes
`repairkit`	Repair Kit	2500	Yes
`screwdriver`	Screwdriver	200	Yes

Field	Default	What it does
`label`	the item name	The name players see.
`weight`	`0`	Weight of one item, in grams (`1000` = 1 kg).
`useable`	`false`	Whether the item can be used. Without `useable = true`, using it does nothing.
`description`	—	The text shown with the item.
`stack`	inventory default (`64`)	Maximum amount per slot for this item.
`unique`	—	`true` makes every item take its own slot (stack of 1).
`weapon`	—	A GTA weapon name such as `'WEAPON_PISTOL'`. Using the item equips or holsters that weapon. Weapon items stack to 1 unless they set `stack`.
`ammo`	—	Rounds loaded the first time a `weapon` item is equipped.

lua

-- server.lua of your own resource
local core = exports['qs-core']

core:RegisterItems({
    coffee_beans = { label = 'Coffee Beans', weight = 250, useable = false, description = 'Freshly roasted.' },
    energy_bar   = { label = 'Energy Bar',   weight = 80,  useable = true,  description = 'A quick snack.' },
    gold_watch   = { label = 'Gold Watch',   weight = 150, useable = false, unique = true },
})

Job	Label	Grades (level: label — salary)
`unemployed`	Civilian	0: Freelancer — 200
`police`	Police	0: Recruit — 500 · 1: Officer — 750 · 2: Sergeant — 1000 · 3: Chief — 2000 (boss)
`ambulance`	EMS	0: Trainee — 500 · 1: Paramedic — 800 · 2: Doctor — 1200 · 3: Chief — 2000 (boss)
`hunter`	Hunter	0: Hunter — 200
`delivery`	Delivery Driver	0: Driver — 200
`miner`	Miner	0: Miner — 175
`lumberjack`	Lumberjack	0: Lumberjack — 175
`fisher`	Fisherman	0: Fisherman — 150

Field	Default	What it does
`label`	the job name	The job name players see.
`defaultDuty`	—	The duty state for a character that has no stored duty value yet (characters created by Quasar Framework start on duty). Scripts read it as `job.onduty`.
`grades`	—	A table of grades indexed from `[0]`.
`grades[n].name`	—	The grade id (for example `'sergeant'`).
`grades[n].label`	—	The grade name players see.
`grades[n].salary`	—	The amount paid to the bank every paycheck. `0` means no paycheck.
`grades[n].isBoss`	`false`	Marks the boss grade. ESX and QBCore scripts see it as the boss rank.

lua

-- qs-core/shared/jobs.lua — add a mechanic job inside the Jobs table
['mechanic'] = {
    label = 'Mechanic',
    defaultDuty = true,
    grades = {
        [0] = { name = 'apprentice', label = 'Apprentice', salary = 300 },
        [1] = { name = 'mechanic',   label = 'Mechanic',   salary = 550 },
        [2] = { name = 'boss',       label = 'Owner',      salary = 1200, isBoss = true },
    },
},

Field	Default	What it does
`label`	the gang name	The gang name players see.
`grades`	`{ [0] = { name = 'member', label = 'Member', isBoss = false } }`	Gang ranks indexed from `[0]`.
`grades[n].name`	—	The rank id.
`grades[n].label`	—	The rank name players see.
`grades[n].isBoss`	`false`	Marks the leader rank.

lua

-- qs-core/shared/gangs.lua — below Gangs['none']
Gangs['ballas'] = {
    label = 'Ballas',
    grades = {
        [0] = { name = 'recruit', label = 'Recruit', isBoss = false },
        [1] = { name = 'og',      label = 'OG',      isBoss = false },
        [2] = { name = 'boss',    label = 'Shot Caller', isBoss = true },
    },
}

Option	Default	What it does
`Config.MaxWeight`	`50000`	How much a player can carry, in grams (50 kg). Adding an item over this limit fails with Too heavy to carry.
`Config.Slots`	`30`	Number of player inventory slots.
`Config.Columns`	`5`	Number of columns of the player grid.
`Config.DefaultStack`	`64`	Maximum amount per slot, unless the item sets its own `stack`. Weapons and `unique` items always stack to 1.
`Config.StartingItems`	`water` ×2, `bread` ×2, `phone` ×1, `id_card` ×1	Items given to every brand-new character.

lua

Config.MaxWeight = 80000 -- 80 kg
Config.Slots = 40
Config.Columns = 5
Config.DefaultStack = 100

Config.StartingItems = {
    { name = 'water',   count = 3 },
    { name = 'bread',   count = 3 },
    { name = 'phone',   count = 1 },
    { name = 'id_card', count = 1 },
    { name = 'bandage', count = 2 },
}

Option	Default	What it does
`Config.TrunkSlots`	`10`	Slots of a vehicle trunk.
`Config.TrunkColumns`	`5`	Columns of the trunk grid.
`Config.TrunkMaxWeight`	`100000`	Trunk weight limit, in grams.
`Config.TrunkReach`	`1.8`	How close (in metres) you must stand to the back of a vehicle for the inventory to open its trunk.
`Config.TrunkCloseDistance`	`5.0`	The trunk closes when you walk farther than this from the vehicle. Also the auto-close distance of stash zones without their own radius.
`Config.GloveboxSlots`	`5`	Slots of a glovebox.
`Config.GloveboxColumns`	`5`	Columns of the glovebox grid.
`Config.GloveboxMaxWeight`	`15000`	Glovebox weight limit, in grams.

Option	Default	What it does
`Config.Stashes`	`{}`	Stashes registered when the server starts: `{ id, label, slots, maxWeight, columns }`.

Option	Default	What it does
`Config.OpenKey`	`'F1'`	Default key that opens and closes the inventory (command `inventory`).
`Config.RadialKey`	`'TAB'`	Default key held to open the item wheel.
`Config.RadialSlots`	`5`	How many slots (from slot 1) the item wheel shows.

Option	Default	What it does
`WeaponsConfig.MagSize`	`pistol = 12`, `smg = 30`, `rifle = 30`, `shotgun = 8`, `sniper = 10`, `mg = 100`, `launcher = 1`, `flare = 1`, `taser = 1`	Rounds per category: the rounds a weapon has the first time it is equipped, and the rounds one ammo item loads.
`WeaponsConfig.ThrowableStack`	`10`	Stack size of throwable weapons (grenades, molotovs...). Each throw uses one item.
`WeaponsConfig.Weapons`	105 weapons	Weapon items: `itemName = { weapon, cat, label, weight, ammo? }`.
`WeaponsConfig.Ammo`	9 ammo types	Ammo items: `itemName = { cat, label, weight }`.

lua

-- Bigger pistol magazines: 15 rounds on first equip and per pistol ammo item
WeaponsConfig.MagSize = {
    pistol   = 15,
    smg      = 30,
    rifle    = 30,
    shotgun  = 8,
    sniper   = 10,
    mg       = 100,
    launcher = 1,
    flare    = 1,
    taser    = 1,
}

-- Inside WeaponsConfig.Weapons: an add-on weapon you stream yourself
weapon_mycarbine = { weapon = 'WEAPON_MYCARBINE', cat = 'rifle', label = 'Custom Carbine', weight = 3400 },

-- Inside WeaponsConfig.Ammo: ammo entries look like this
ammo_pistol = { cat = 'pistol', label = 'Pistol Ammo', weight = 200 },

Option	Default	What it does
`name`	`'QSCORE'`	The big title — your server name.
`subtitle`	`'Roleplay Framework'`	The line under the title.
`about`	`'Open-source roleplay framework · runs ESX & QBCore scripts'`	A one-line description under the subtitle.
`keys`	8 entries: `F1` Inventory, `TAB` Item wheel, `1-5` Quick slots, `E` Interact, `U` Lock vehicle, `B` Seatbelt, `G` Hotwire, `T` Chat	Key hints shown as `{ key, label }` pairs.
`tips`	5 tips	Lines that rotate at the bottom of the screen.
`tipInterval`	`5.2`	Seconds between two tips.

javascript

// loading screen branding. no build step, just restart the resource.
window.LOADING_CONFIG = {
  name: 'LOS SANTOS RP',
  subtitle: 'Serious Roleplay',

  about: 'Whitelisted roleplay community · discord.gg/yourserver',

  keys: [
    { key: 'I', label: 'Inventory' },   // matches Config.OpenKey = 'I'
    { key: 'TAB', label: 'Item wheel' },
    { key: '1-5', label: 'Quick slots' },
    { key: 'U', label: 'Lock vehicle' },
    { key: 'T', label: 'Chat' },
  ],

  // rotating lines at the bottom
  tips: [
    'Read the rules on our Discord before you play.',
    'Use /me and /do in the chat to roleplay your actions.',
  ],

  tipInterval: 6, // seconds
};

Page	What it covers
Installation	`server.cfg`, admins, language and the database.
Inventory, Items & Weapons	Usable items, stashes, shops and the full weapon list.
Jobs, Police & EMS	The job center, civilian jobs, police and EMS settings.
Administration	Admin menu, groups, bans and webhooks.
Commands and Exports	Every command, export and event.

Configuration

Configuration

Core settings — qs-core/shared/config.lua#

Accounts and starting money#

Characters, spawn and saving#

Paycheck#

Death and hospitals#

World toggles#

Webhooks and bans#

Inventory backend#

Identifiers and language fallback#

Theme colours#

Per-player palettes#

Languages#

Adding a language#

Copy the English file

Rename the table and translate

Switch the server to it

Items#

Base items#

Item fields#

Adding items#

Jobs and grades#

Default jobs#

Job fields#

Gangs#

Inventory — qs-coreinventory/shared/config.lua#

Player inventory#

Trunk and glovebox#

Stashes#

Keys#

Weapons — qs-coreweapons/config.lua#

Loading screen — loadingscreen/config.js#

Core settings — qs-core/shared/config.lua#

Accounts and starting money#

Characters, spawn and saving#

Paycheck#

Death and hospitals#

World toggles#

Webhooks and bans#

Inventory backend#

Identifiers and language fallback#

Theme colours#

Per-player palettes#

Languages#

Adding a language#

Copy the English file

Rename the table and translate

Switch the server to it

Items#

Base items#

Item fields#

Adding items#

Jobs and grades#

Default jobs#

Job fields#

Gangs#

Inventory — qs-coreinventory/shared/config.lua#

Player inventory#

Trunk and glovebox#

Stashes#

Keys#

Weapons — qs-coreweapons/config.lua#

Loading screen — loadingscreen/config.js#

Related pages#