FiveM Development

Dynamic documentation orchestrator for FiveM resource development. Supports QBox, QBCore, ESX frameworks with Lua and NUI (JS/TS).

Philosophy

1. Fetch, don't memorize - Always get latest from authoritative sources
2. Framework-agnostic thinking - Understand patterns, adapt to framework
3. Performance-first - FiveM has strict tick budgets
4. Security-aware - Server-side validation is non-negotiable

CRITICAL: No Hallucination Policy

NEVER invent or guess native functions, framework APIs, or parameters.

Rules:

1. If unsure about a native → MUST fetch from https://docs.fivem.net/natives/
2. If unsure about framework API → MUST fetch from official docs
3. If function doesn't exist → Tell user honestly, suggest alternatives
4. If parameters unknown → Fetch documentation, don't guess

Before writing any native or API call:

• Is this a real FiveM native? → Verify at docs.fivem.net/natives
• Is this the correct function name? → Check exact spelling
• Are these the correct parameters? → Verify parameter order and types
• Does this work on client/server/both? → Check availability

When you don't know:

"I'm not 100% certain about this native/API. Let me fetch the documentation..."
[Use WebFetch to get accurate info]

Verification Sources:

Example - WRONG:

-- DON'T: Inventing a native that might not exist
SetPlayerInvincible(playerId, true)  -- Is this real? What are the params?

Example - RIGHT:

-- DO: Use verified native with correct params
SetEntityInvincible(PlayerPedId(), true)  -- Verified at docs.fivem.net

Content Map

Read ONLY relevant files based on the request:

Dynamic Fetching - Decision Tree

Step 1: Classify the Request

Step 2: WebFetch URLs

Native Functions

Base URL: https://docs.fivem.net/natives/

WebFetch(
  url: "https://docs.fivem.net/natives/",
  prompt: "Find documentation for the native function '{FUNCTION_NAME}'.
           Include: parameters, return values, usage examples,
           client/server availability."
)

Native Categories:

Framework Documentation

QBox:

WebFetch(
  url: "https://docs.qbox.re/",
  prompt: "Find documentation for QBox '{FEATURE}'.
           Include exports, events, and usage examples."
)

QBCore:

WebFetch(
  url: "https://docs.qbcore.org/qbcore-documentation/",
  prompt: "Find documentation for QBCore '{FEATURE}'.
           Include: function signature, parameters, examples."
)

ESX Legacy:

WebFetch(
  url: "https://docs.esx-framework.org/",
  prompt: "Find documentation for ESX '{FEATURE}'.
           Include: xPlayer methods, events, server/client functions."
)

ox_lib:

WebFetch(
  url: "https://overextended.dev/ox_lib",
  prompt: "Find documentation for ox_lib '{MODULE}'.
           Include: function signatures, options, examples."
)

Asset Discovery

PlebMasters Forge:

WebFetch(
  url: "https://forge.plebmasters.de/",
  prompt: "Search for GTA V {ASSET_TYPE} matching '{SEARCH_TERM}'.
           Return model names/hashes that can be used in FiveM."
)

Asset Types: objects, vehicles, peds, weapons, clothes, animations

Request Router - Pattern Matching

RULE 1: Native Detection

Triggers when:

• Specific native name (PascalCase like GetPlayerPed, CreateVehicle)
• "native function", "GTA native", "FiveM native"
• Hash reference (0x...)

Action: Fetch from https://docs.fivem.net/natives/

RULE 2: Framework API Detection

Triggers when:

• QBCore.Functions.*, QBCore.Player.*
• exports.qbx_core:*, exports['qb-core']:*
• ESX.Get*, xPlayer:*, ESX.RegisterServerCallback
• exports.es_extended:*

Action: Detect framework → Fetch from appropriate docs

RULE 3: ox_lib Detection

Triggers when:

• lib.* functions
• exports.ox_lib:*
• Modules: callback, notify, menu, context, progress, zones, target

Action: Fetch from https://overextended.dev/ox_lib

RULE 4: Asset Discovery

Triggers when:

• "What's the model for...", "prop name for...", "vehicle spawn name"
• Object placement, ped models, weapon models

Action: Guide to PlebMasters Forge + provide usage example

RULE 5: Local Knowledge

Triggers when:

• fxmanifest.lua structure
• Client/server patterns
• Thread management
• Project structure

Action: Read relevant local markdown file

Framework Auto-Detection

When starting a task, detect the active framework from project files:

Check fxmanifest.lua

-- QBox indicators
dependency 'qbx_core'
dependency 'ox_lib'

-- QBCore indicators
dependency 'qb-core'

-- ESX indicators
dependency 'es_extended'
dependency 'esx_core'

Check code imports

-- QBox
local QBX = exports.qbx_core:GetCoreObject()

-- QBCore
local QBCore = exports['qb-core']:GetCoreObject()

-- ESX
local ESX = exports.es_extended:getSharedObject()

Best Practices (Quick Reference)

Performance Rules

Security Rules

Resource Structure

resource_name/
├── fxmanifest.lua
├── config.lua
├── client/
│   └── main.lua
├── server/
│   └── main.lua
├── shared/
│   └── config.lua
└── html/              # NUI
    ├── index.html
    ├── style.css
    └── script.js

Framework-Agnostic Pattern

local Framework = {}

if GetResourceState('qbx_core') ~= 'missing' then
    Framework.Core = exports.qbx_core:GetCoreObject()
    Framework.Type = 'qbox'
elseif GetResourceState('qb-core') ~= 'missing' then
    Framework.Core = exports['qb-core']:GetCoreObject()
    Framework.Type = 'qbcore'
elseif GetResourceState('es_extended') ~= 'missing' then
    Framework.Core = exports.es_extended:getSharedObject()
    Framework.Type = 'esx'
end

return Framework

Anti-Patterns

Related Skills