110 online 3 members  + Join RP Base  +
FreeScriptQBoxQBCoreESX

fivem-script-dev

by ZoniBoy00  ·  version 2026.10.29  ·  updated 2 days ago

No reviews yet

Downloads
0
Reviews
0
Size
107 KB
Code check
Clean
Licence
MIT
Released
Nov 2026

Comprehensive FiveM (cfx.re) script development skill for AI assistants - ESX, QBCore, QBox, Ox resources, NUI, security and optimization

fivem-script-dev
FiveM Script Development — AI Context Pack
A structured knowledge pack for AI-assisted FiveM script development.
Supports ESX, QBCore, QBox, and the Ox ecosystem with reviewed templates and security-focused best practices.

📦 What's Inside
fivem-script-dev/
├── SKILL.md                           ← Master reference + usage guide
├── references/                        ← 21 focused reference documents
│   ├── fivem-basics.md               Resource structure, manifest, events
│   ├── lua-for-fivem.md              Lua best practices for FiveM
│   ├── scripting-languages.md        Lua vs JS vs C# comparison
│   ├── esx-framework.md              ESX (xPlayer, esx_lib, esx_notify, inventory)
│   ├── qbcore-framework.md           QBCore (Player, jobs, gangs)
│   ├── qbox-framework.md             QBox (bridge, FAQ, QBCore→QBox)
│   ├── ox-lib.md                     UI, callbacks, zones, commands
│   ├── oxmysql.md                    Queries, transactions, placeholders
│   ├── ox-inventory-target.md        Inventory/target exports, hooks, qb-target migration
│   ├── ace-permissions.md            ACE groups, identifiers, allow/deny
│   ├── common-patterns.md            Shop, doors, vehicles, whitelist
│   ├── standalone-and-bridge.md      Multi-framework bridge patterns
│   ├── custom-integrations.md        Paid scripts, custom notify/target
│   ├── fivem-nui.md                  NUI HTML/JS ↔ FiveM communication
│   ├── fivem-security.md             Anti-exploit, game events, sandbox
│   ├── onesync.md                    Entity lockdown, server spawns, buckets
│   ├── server-cfg.md                 Convars, artifacts, txAdmin updates
│   ├── error-handling.md             pcall, debugging, defensive code
│   ├── other-resources.md            Fivemanage, state bags
│   ├── documentation-and-versioning.md Official-source and freshness checks
│   └── optimization.md               Budgets, points/keybinds, cache, networking, NUI
├── scripts/check_lua_blocks.py        ← CI syntax check for
lua blocks
└── templates/ ← 10 adaptable templates
├── fxmanifest.lua Universal manifest template
├── nui/ Plain NUI scaffold (client.lua + HTML/CSS/JS)
├── nui-vite/ Vite + TypeScript NUI (typed bridge, dev mode, ox_lib callbacks)
├── esx-resource.lua ESX resource scaffold
├── qbcore-resource.lua QBCore resource scaffold
├── qbox-resource.lua QBox resource scaffold
├── oxmysql-queries.lua Database query patterns
├── admin-command.lua ACE + rate limits + Discord logging
├── discord-webhook.lua Rich embed logger with presets
└── inventory-hooks.lua ox_inventory items, shops, crafting

**🎯 Who Is This For?**
Role, Benefit

**FiveM Server Owners**, Get AI-generated scripts that follow modern standards from day one
**FiveM Script Developers**, Reference battle-tested patterns and avoid common security/performance pitfalls
**AI Users (ChatGPT, Claude, Gemini)**, Feed the `references/` files as context — the AI will write correct, secure, and optimized Lua
**ESX → QBox Migrators**, Dedicated QBox reference with conversion guide

**🚀 How to Use with AI****Option 1: Feed one reference at a time (recommended)**
When asking an AI to help with a specific task, include the relevant reference:

> "Write a FiveM shop script using ESX. Follow the patterns in this reference:"
> 
> [paste `references/esx-framework.md`]
**Option 2: Load the full pack into an AI agent**
If your AI agent supports skills, copy the folder into its skills directory:
bash
Claude Code — personal (all projects)
git clone https://github.com/ZoniBoy00/fivem-script-dev ~/.claude/skills/fivem-script-dev
Claude Code — one project only (commit it with the project)
git clone https://github.com/ZoniBoy00/fivem-script-dev .claude/skills/fivem-script-dev
Hermes
cp -r fivem-script-dev ~/.hermes/skills/gaming/

The folder name must match `name:` in `SKILL.md` (`fivem-script-dev`).

The AI will then automatically reference the correct patterns when you ask FiveM-related questions.
**Option 3: Use in Codex**
For a repository-scoped Codex skill, place it under `.agents/skills/fivem-script-dev/` in the repository that needs it. Keep `SKILL.md` concise and load only the references needed for the task. For reusable distribution, package the skill as a Codex plugin.
**Option 4: Templates for rapid scaffolding**
Use templates when starting a new resource:
bash
cp templates/esx-resource.lua my_new_resource/server.lua
cp templates/fxmanifest.lua my_new_resource/
`

🧠 Core Philosophies🔒 Never Trust the Client
Every action that affects game state, economy, or other players must be validated on the server. The client is fully compromised.
🦊 Ox First
Prefer the Ox ecosystem (ox_lib, ox_inventory, oxmysql, ox_target) when it is installed and compatible with the selected framework. Do not replace framework-native APIs without a documented bridge.
⚡ Performance by Default
Variable wait intervals, event-driven zones, state bags over event spam — every reference document includes performance considerations.
🔧 Framework-Agnostic Patterns
Common patterns (shops, doors, vehicles) are written with adapters for ESX, QBCore, and QBox — not locked into one framework.

📚 Framework Support
Framework, Status, Notes

ESX Legacy, ✅ Full support, es_extended, xPlayer API
QBCore, ✅ Full support, qb-core, Player object
QBox, ✅ Full support, qbx_core, Ox-native
Standalone, ✅ Supported, Ox ecosystem only

🔗 Quick Links

…