QBCore Documentation

Welcome to the official QBCore Framework documentation — your comprehensive resource for building powerful FiveM roleplay servers. QBCore is the most popular open-source framework for FiveM, providing a robust foundation with player management, job systems, economy, inventory, and extensive customization options.

What is QBCore?

QBCore is a comprehensive FiveM roleplay framework designed for server owners and developers who want to create immersive gaming experiences. Built with performance, modularity, and ease of use in mind, it powers thousands of FiveM servers worldwide.

Key Features

• 🎮 Player Management System — Complete player data handling with multi-character support, jobs, gangs, and metadata
• 💼 Dynamic Job Framework — Flexible job system with grades, duties, and boss actions
• 💰 Economy System — Multiple currency support (cash, bank, crypto) with transaction logging
• 📦 Inventory System — Modern item-based inventory with crafting and trading capabilities
• 🔒 Built-in Security — Anti-cheat protection and secure event handling
• ⚡ High Performance — Optimized for large player counts with efficient resource usage
• 🌍 Multi-Language Support — Localization system for global servers
• 📚 Extensive API — Powerful functions and events for resource development

Documentation Sections

Explore our comprehensive documentation organized by topic:

Quick Navigation

Installation & Setup

• Windows Installation — Step-by-step Windows server setup guide
• Linux Installation — Linux/Ubuntu server installation instructions
• Hosting Guide — Choosing and configuring your hosting environment

Core Documentation

• Core Framework — Understanding the core framework architecture and components
• Player Data — Player data structure, management, and persistence
• Events — Framework events and client-server communication
• Database Schema — Database structure, tables, and relationships

Development & Guides

• Guides — Practical walkthroughs for common development tasks
• Advanced Topics — Custom resources, security hardening, and production setup
• Performance — Server optimization, profiling, and best practices
• Troubleshooting — Common issues, error fixes, and debugging tips

Migration & Tools

• Migration — ESX to QBCore migration guides and upgrade tools
• Overview & FAQ — High-level framework context, glossary, and common questions

Resources & Tools

• Official Resources — Documentation for official QBCore resources
• Resources Hub — Scripts, HUDs, inventory systems, and community tools
  • Inventory Systems — Compare QBCore, LJ, and QB Inventory V2
  • Marketplace Guide — Trusted FiveM asset stores and buying guidance
• Tools Hub — Essential utilities including backup manager, health monitor, and config validators
• HUD Options — HUD systems, customization, and configuration

Framework Architecture

QBCore follows a modular architecture that separates concerns into manageable components:

┌─────────────────────────────────────────────────────────────┐
│                    QBCore Framework                         │
├─────────────┬─────────────┬─────────────┬───────────────────┤
│   Core      │   Player    │   Shared    │   Resources       │
│   Object    │   Data      │   Data      │   (qb-*)          │
├─────────────┼─────────────┼─────────────┼───────────────────┤
│ • Functions │ • Character │ • Items     │ • qb-inventory    │
│ • Events    │ • Jobs      │ • Vehicles  │ • qb-hud         │
│ • Callbacks │ • Money     │ • Jobs      │ • qb-phone       │
│ • Commands  │ • Inventory │ • Gangs     │ • qb-garages     │
│             │ • Metadata  │ • Weapons   │ • ...            │
└─────────────┴─────────────┴─────────────┴───────────────────┘

Getting Help

Support Channels

• GitHub Discussions  — Community support, Q&A, and feature discussions
• GitHub Issues  — Bug reports, feature requests, and technical issues
• Support Page — Additional support resources, FAQ, and troubleshooting guides

Quick Links

• Download QBCore — Get the latest framework release and starter packs
• Tutorials — Beginner to advanced video and written tutorials
  • Beginner Tutorials — Framework fundamentals and first scripts
  • Intermediate Tutorials — Custom jobs, inventory, and UI development
  • Advanced Tutorials — Optimization, security, and architecture
• News & Updates — Latest announcements, updates, and FiveM mod recommendations
  • Best FiveM Mods Sites 2025 — Top resources for scripts and content
• Community — Connect with other QBCore developers and server owners

Code Example

Here’s a quick example of how to interact with QBCore in your resources:

-- Server-side: Access the core object
local QBCore = exports['qb-core']:GetCoreObject()
 
-- Get a player and check their job
RegisterNetEvent('myresource:checkJob', function()
    local src = source
    local Player = QBCore.Functions.GetPlayer(src)
    
    if not Player then return end
    
    if Player.PlayerData.job.name == "police" then
        -- Give police bonus
        Player.Functions.AddMoney("bank", 500, "police-duty-bonus")
        TriggerClientEvent('QBCore:Notify', src, 'Police bonus received!', 'success')
    end
end)

Contributing

QBCore is open source and welcomes contributions from the community. Whether you’re fixing bugs, adding features, or improving documentation, your contributions help make QBCore better for everyone.

• GitHub Organization  — Browse all official repositories
• Development Guide — Learn how to contribute to the framework

See Also

Ready to build your FiveM roleplay server? Start with the Quickstart Guide or explore the Installation section to get QBCore running on your server today.