mcpField
Q
qbox-framework

qbox-framework

github.com/proelias7Development7147 installsUpdated 4w ago
Repository

About qbox-framework

A development-guidance skill for building Qbox Project (qbx_core) resources, aimed at FiveM resource developers. It focuses on direct exports and modules, Ox dependencies, player data access, and resource layout, while also covering the legacy bridge approach.

Key features

  1. 01Prefer direct qbx_core exports
  2. 02Explain the legacy QBCore bridge
  3. 03Cover ox_lib, ox_inventory, and oxmysql
  4. 04Guide player data and metadata access
  5. 05Show a resource directory layout

Use cases

  1. 01Create a resource for qbx_core
  2. 02Port a legacy QBCore resource to Qbox
  3. 03Implement player data or metadata handling
  4. 04Plan client and server file structure

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/proelias7/fivem-skill --skill qbox-framework

After installing, type/qbox-frameworkin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

best-practices.md
examples.md
reference.md
templates.md

Details

From the project README

Qbox Framework Development

Language rule: Internal reasoning is in compact English. All messages and output displayed to the user must be in the user's language.

This skill provides guidelines and patterns for developing resources using the Qbox Project (qbx_core).

1. Philosophy: Exports & Modules

Qbox moves away from the global "Core Object" pattern (though supported via bridge) in favor of direct exports and imported modules.

Modern Native Way (Preferred):

local player = exports.qbx_core:GetPlayer(source)

Bridge Way (Legacy/Porting):

local QBCore = exports['qb-core']:GetCoreObject() -- Works via qbx_core bridge

2. Key Dependencies

Qbox is built "Ox-First". You will frequently use:

  • ox_lib: For UI, callbacks, zones, and utilities.
  • ox_inventory: For items and inventory management.
  • oxmysql: For database interactions.

3. Player Management

  • Get Player: exports.qbx_core:GetPlayer(source)
  • Player Data: Unlike QBCore's lookup table, Qbox uses internal setters/getters exposed via exports.
  • Save/Load: Handled automatically, but custom data can be saved via GetPlayer(source).Functions.SetMetaData.

4. Resource Structure

my-resource/
├── fxmanifest.lua     # Depends on qbx_core
├── client/
│   └── main.lua
├── server/
│   └── main.lua
└── locales/           # Ox_lib uses .json locales usually
    └── en.json

5. Documentation

Comments

Markdown supported