DocumentationdevelopmentOverview

Development Guide

Welcome to the QBCore development documentation. This section will help you set up your development environment and learn pract tical workflows for creating and maintaining QBCore resources.

Getting Started

  • VS Code Setup — Configure your editor with extensions, snippets, and settings tailored for Q BCore.
  • Debugging QBCore Resources — Build a repeatable troubleshooting workflow with logging, the Even t Debugger, and the Config Validator.
  • Development Best Practices — Adopt coding standards, review rituals, and release checklists that keep resources stable.
  • Performance Tuning — Benchmark your server, remove bottlenecks, and monitor changes over time .

Development Workflow

  1. Environment Setup — Configure your IDE and tools (see VS Code Setup).
  2. Resource Creation — Structure your scripts, exports, and configuration following the [Development Best Practices](/docs/d evelopment/best-practices).
  3. Testing — Trace events and validate configs with the Debugging guide and the Config Validator.
  4. Performance Review — Profile new features using the Performance Tuning guide and the Ev en t Debugger.
  5. Deployment — Document release notes, update manifests, and coordinate rollouts with your team.

Tools & Resources

QBCore provides several tools to make development easier:

  • Config Validator — Scan configuration files for mistakes, missing data, and costly polling loops.
  • Event Debugger — Inspect client/server event flow, payloads, and timings in real time.
  • Built-in debugging functions such as QBCore.Functions.Print and logging helpers.
  • Development commands and profiling utilities for capturing performance snapshots.
  • Resource templates and starter projects to accelerate new system builds.