VS Code Setup for QBCore Development - QBCore Guide for FiveM
Introduction
This tutorial turns VS Code Setup for QBCore Development 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: Prerequisites
In this step, you will apply the prerequisites concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 2: Essential Extensions
In this step, you will apply the essential extensions concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 3: Lua Development
In this step, you will apply the lua development concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 4: Web Development (for NUI)
In this step, you will apply the web development (for nui) concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 5: Git Integration
In this step, you will apply the git integration concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 6: Productivity Extensions
In this step, you will apply the productivity extensions concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 7: VS Code Configuration
In this step, you will apply the vs code configuration concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 8: User Settings (settings.json)
In this step, you will apply the user settings (settings.json) concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Code Example
"luau-lsp.require.mode": "relativeToFile",
"luau-lsp.require.directoryAliases": {
"@": "src"
}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.