qbcore-framework

Provides guidance for building Lua resources on the QML Core/Framework.

6|3|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/proelias7/fivem-skill --skill qbcore-framework
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: qbcore-framework
Source: https://github.com/proelias7/fivem-skill/tree/main/skills/qbcore-framework
Command: npx skills add https://github.com/proelias7/fivem-skill --skill qbcore-framework

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides structured guidance for developing resources on the FiveM QBCore framework, helping teams write consistent, maintainable code.

Core Features & Use Cases

  • Core Object & Player Data: Demonstrates how to obtain the QBCore core object and access Player data reliably across client and server scripts.
  • APIs, Callbacks & Events: Illustrates using QBCore.Functions.GetPlayer, CreateCallback, and TriggerCallback patterns, plus event-driven data updates.
  • Database & Items: Shows how to interact with the database via oxmysql or equivalent, and how to define and use items within resources.
  • Structure & Best Practices: Provides standard resource layout, citations to official docs, and common best practices for performance and security.

Quick Start

Initialize a basic QBCore resource by creating client/main.lua and server/main.lua with a top-level line: local QBCore = exports['qb-core']:GetCoreObject() and follow the patterns in this skill.

Frequently Asked Questions about qbcore-framework

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I get the QBCore core object in a FiveM resource?

To use QBCore in a FiveM resource, add local QBCore = exports['qb-core']:GetCoreObject() to the top of your client or server main.lua file. This establishes the core object needed to access framework functions.

What is the best way to handle player data in QBCore server scripts?

Handling QBCore player data requires using QBCore.Functions.GetPlayer on the server side to retrieve the player object. You can then access and modify player data through this object using established QBCore patterns and event-driven updates.

How do I create and trigger callbacks in FiveM QBCore resources?

QBCore callbacks use CreateCallback on the server to register a callback and TriggerCallback on the client to request data. This pattern facilitates secure, structured communication between client and server Lua scripts.

Does QBCore support oxmysql for database access?

Yes, QBCore resources use oxmysql for database access. You can interact with the database using oxmysql queries to safely retrieve and store player, item, and resource data following standard FiveM server-side Lua practices.

What are the standard file layouts and best practices for a QBCore resource?

Standard QBCore resources use separate client/main.lua and server/main.lua files. Best practices include adhering to coreObject retrieval patterns, using oxmysql safely, and following established performance and security guidelines for maintainable code.