Development Best Practices - QBCore Guide for FiveM
Introduction
This tutorial turns Development Best Practices into a clean, developer-friendly guide for QBCore/FiveM. You will follow a step-by-step flow, copy the relevant code patterns, and learn the “why” behind the setup.
Requirements
- QBCore installed and running on a dev server
- Basic Lua knowledge and comfort reading FiveM patterns
- A test workflow for iterating safely (dev server, not production)
- Optional: a code editor with Lua/FiveM helpers (VS Code recommended)
Step-by-Step Guide
Step 1: Keep Resources Modular
In this step, you will apply the keep resources modular concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 2: Manage Configuration Like Code
In this step, you will apply the manage configuration like code concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 3: Build Robust Event Flows
In this step, you will apply the build robust event flows concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 4: Protect Server Performance
In this step, you will apply the protect server performance concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 5: Collaborate Deliberately
In this step, you will apply the collaborate deliberately concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 6: Release Readiness Checklist
In this step, you will apply the release readiness checklist concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 7: See Also
In this step, you will apply the see also concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Code Example
-- Example: QBCore callback pattern
local QBCore = exports['qb-core']:GetCoreObject()
QBCore.Functions.CreateCallback('tutorials:getPlayerJob', function(source, cb)
local Player = QBCore.Functions.GetPlayer(source)
if not Player then return cb(nil) end
cb({
job = Player.PlayerData.job.name,
grade = Player.PlayerData.job.grade and Player.PlayerData.job.grade.level or 0,
})
end)Tips & Best Practices
- Keep authority on the server: validate inputs before money/database operations.
- Start with one resource/module at a time, then refactor after you verify it works.
- Use callbacks for request/response flows and events for push/UX updates.
- When you run loops, avoid freezes: always yield with Wait() (client/server) and cache hot values.