📚 QBCore Glossary

Key terms and acronyms you will encounter while running or developing a QBCore server.

A

ACL (Access Control List)

Permission system used by FiveM to control command access. Configure in server.cfg using add_ace and add_principal.

API (Application Programming Interface)

Interfaces exposed by QBCore resources, accessed with exports such as exports['qb-core']:GetCoreObject().

B

Ban Wave

Coordinated removal of rule-breaking players. Automate using moderation tools and central logging.

Baseevents

FiveM resource that emits player connect/disconnect events. QBCore depends on it for player lifecycle hooks.

C

Citizen ID

Unique identifier assigned to each character in QBCore. Stored as Player.PlayerData.citizenid and used across databases.

Callback

Server-side function registered with QBCore.Functions.CreateCallback that returns data to the client. See NUI Form with Callback.

D

Duty System

Mechanism that toggles job availability (e.g., police on/off duty). Managed through Player.Functions.SetJob and metadata flags.

E

ESX

Another FiveM framework. Migration guidance is covered in ESX to QBCore.

F

Framework Update

Major or minor release of QBCore. Track changes in the Changelog and review breaking changes before updating.

G

Gang System

Optional metadata structure that parallels jobs. Access with Player.PlayerData.gang and configure in qb-core/shared/gangs.lua.

H

Headbag

Roleplay mechanic for kidnapping scenarios. Typically implemented in police/criminal scripts; ensure Safe Server Events when toggling.

I

Inventory Slot

Container inside qb-inventory. Each slot stores name, amount, and metadata.

J

Job Grade

Defines responsibility levels inside a job. Higher grades unlock permissions; configure them in qb-core/shared/jobs.lua.

L

Ledger

Term for tracking player transactions. Use qb-management or custom logging scripts.

M

Metadata

Flexible JSON data attached to players, vehicles, or items. Access via Player.PlayerData.metadata.

MySQL Async

Legacy database library replaced by oxmysql/mysql-async. QBCore ships with an optimized wrapper; keep queries parameterized.

N

NUI (New UI)

FiveM browser-based UI framework. Combine with callbacks to send data securely; see NUI Form with Callback.

O

OneSync

FiveM networking technology enabling more than 32 players. Enable in server.cfg and tune networking via Server Optimization.

P

PlayerData

Primary data structure representing characters. Contains job, gang, money, metadata, and status values.

Principal

Identity in FiveM ACL. Map Steam identifiers to principals so you can grant permissions for tools like resmon.

R

Resmon

Resource monitor used to measure performance impact. Learn usage in Resmon Basics.

S

Safe Event

Server event protected by validation, authorization, and logging. Implement guidelines from Safe Server Events.

T

TxAdmin

Web-based control panel for FiveM servers. Use it to manage recipes, players, and scheduled restarts.

U

Update Ring

Release channel (stable, experimental) you choose for artifacts or resources. Stick to one ring per environment to avoid mismatched builds.

V

Vehicle State

Stored data about player vehicles (garage location, fuel, damage). Managed by resources like qb-garages and qb-vehicleshop.

W

Whitelist

List of identifiers allowed to join. Implement via ACL or dedicated resources; ensure proper logging.

Z

Zero Downtime

Deployment strategy where staging updates are rolled out gradually to avoid outages. Requires load balancing or redundant instances.