# FiveM Docs > Independent, task-focused documentation for FiveM players, server owners, and resource developers. Website: https://fivemdocs.com This is not the official Cfx.re documentation. Read the linked guide and its primary references for API contracts and limitations. This directory is generated from public documentation routes and metadata. It contains no private repository source, credentials, or runtime configuration. ## Documentation - [Contributing and reporting documentation issues](): How to improve the official Cfx documentation, and why direct public contributions to this independent FiveM Docs site are not currently available. - [Find Your FiveM Answer: Players, Servers, and Scripting](): Find FiveM guides by task: fix a client, migrate a server, inspect event contracts, compile JS/C# resources, author assets and test real failure cases. - [Choosing a FiveM Framework](): Choose a FiveM framework with a practical checklist for scripts, developer skills, deployment, compatibility, performance testing and migration risk. - [ESX Legacy Framework Overview](): ESX Legacy in 2026 — the esx\_core monorepo, what ships in the core folder, release cadence, and where the real docs live. - [ESX Legacy Installation Guide](): Install ESX Legacy on FiveM via the txAdmin recipe or from the esx\_core monorepo, with MariaDB setup and validation steps. - [ESX Legacy Core Resources](): What ships in the esx\_core monorepo and the ESX-Legacy-Addons repository — core, jobs, economy, property and UI resources. - [ESX Structure and xPlayer API](): How ESX Legacy is organised — the ESX object, xPlayer fields, the current account and inventory API, and the core events. - [Legacy FiveM Frameworks](): vRP and other retired FiveM frameworks — what to know if you inherit one, and how to plan a realistic exit. - [FiveM Framework Migration](): Plan a move between FiveM frameworks — ESX to QBCore, QBCore to Qbox, and off vRP — with data, resource and rollback checks. - [ND Core Framework Overview](): ND Core is a lightweight GPL-3.0 FiveM framework built on ox\_lib and oxmysql, with its own family of add-on resources. - [ND Core Installation Guide](): Install ND Core on FiveM with the txAdmin remote recipe or manually, including artifact, game build and OneSync requirements. - [FiveM Framework Comparison: QBCore, ESX, Qbox & More](): Compare QBCore, ESX Legacy, Qbox, ox\_core, ND Core and vRP: features, script compatibility, setup, migration, websites and GitHub repositories. - [ox\_core Framework Overview](): ox\_core is a developer-first FiveM framework from Overextended, built on ox\_lib, ox\_inventory, ox\_target and oxmysql. - [ox\_core Installation Guide](): Set up ox\_core on FiveM — oxmysql, ox\_lib and ox\_inventory dependencies, the build toolchain, start order and validation. - [ox\_core Structure and API](): How ox\_core models users, characters, groups, accounts and vehicles, plus the Lua and TypeScript entry points and events. - [QBCore Framework Overview](): What QBCore is in 2026, where the code moved after the August organisation change, and which docs to use for each topic. - [QBCore Installation Guide](): Install QBCore on FiveM with the txAdmin recipe or a manual qb-core setup, including database import and validation steps. - [QBCore Official Resources](): The qb-\* resources shipped with QBCore in 2026 — core, inventory, jobs, economy and UI — plus the common community swaps. - [QBCore Structure and Core Object](): How qb-core is organised — the QBCore object, PlayerData shape, money accounts, jobs, and the main server and client events. - [Qbox Framework Overview](): Qbox in 2026 — the qbx\_core fork of QBCore built on the Overextended stack, and how it differs from qb-core. - [Qbox Installation Guide](): Install Qbox with the txAdmin recipe, including the MariaDB 10.9 requirement, manual setup and post-install validation. - [Qbox Structure and Core Exports](): How qbx\_core is organised — the exports API, player data shape, jobs and groups, and the events it shares with QBCore. - [FiveM Game References](): Look up Game References identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM Blips: IDs, Sprites & Map Icons](): Browse 883 FiveM blip sprites and 100 colour entries. Search IDs, preview icons, save favourites and generate Lua or JavaScript blip code. - [Checkpoints](): Complete reference of all GTA V / FiveM checkpoint types and IDs. - [FiveM Controls](): Complete reference of all GTA V / FiveM control IDs, names, and default key bindings. - [Data Files](): Complete reference of all GTA V / FiveM data file types for resource manifests. - [Game Events](): Complete reference of all GTA V / FiveM game events for AddEventHandler usage. - [FiveM Gamer Tags: Components, Players and Cleanup](): Look up gamer-tag component IDs, create tags for player indexes rather than ped handles, update voice visibility and clean up on scope or ped changes. - [HUD Colors](): Complete reference of all GTA V / FiveM HUD color IDs with colour preview swatches. - [Input Mapper](): Complete reference of FiveM input mapper key names and device types for RegisterKeyMapping. - [FiveM DIGITALBUTTON\_AXIS](): Look up DIGITALBUTTON\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM GAME\_CONTROLLED](): Look up GAME\_CONTROLLED identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_AXIS](): Look up JOYSTICK\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_AXIS\_NEGATIVE](): Look up JOYSTICK\_AXIS\_NEGATIVE identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_AXIS\_POSITIVE](): Look up JOYSTICK\_AXIS\_POSITIVE identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_BUTTON](): Look up JOYSTICK\_BUTTON identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_IAXIS](): Look up JOYSTICK\_IAXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_POV](): Look up JOYSTICK\_POV identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM JOYSTICK\_POV\_AXIS](): Look up JOYSTICK\_POV\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM KEYBOARD](): Look up KEYBOARD identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MKB\_AXIS](): Look up MKB\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_ABSOLUTEAXIS](): Look up MOUSE\_ABSOLUTEAXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_BUTTON](): Look up MOUSE\_BUTTON identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_BUTTONANY](): Look up MOUSE\_BUTTONANY identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_CENTEREDAXIS](): Look up MOUSE\_CENTEREDAXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_NORMALIZED](): Look up MOUSE\_NORMALIZED identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_RELATIVEAXIS](): Look up MOUSE\_RELATIVEAXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_SCALEDAXIS](): Look up MOUSE\_SCALEDAXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM MOUSE\_WHEEL](): Look up MOUSE\_WHEEL identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM PAD\_ANALOGBUTTON](): Look up PAD\_ANALOGBUTTON identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM PAD\_AXIS](): Look up PAD\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM PAD\_DEBUGBUTTON](): Look up PAD\_DEBUGBUTTON identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM PAD\_DIGITALBUTTON](): Look up PAD\_DIGITALBUTTON identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM PAD\_DIGITALBUTTONANY](): Look up PAD\_DIGITALBUTTONANY identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM TOUCHPAD\_ABSOLUTE\_AXIS](): Look up TOUCHPAD\_ABSOLUTE\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [FiveM TOUCHPAD\_CENTERED\_AXIS](): Look up TOUCHPAD\_CENTERED\_AXIS identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [Instructional Buttons](): Complete reference of all GTA V / FiveM instructional button constants for scaleform UI. - [FiveM Markers](): Complete reference of all GTA V / FiveM marker types with descriptions. - [Network Events](): Complete reference of all GTA V / FiveM network game events. - [FiveM Ped Models List and Spawn Examples](): Search 860 GTA V and FiveM ped model names and hashes, then use safe Lua or JavaScript examples to load, spawn, and release a ped. - [Pickup Hashes](): Complete reference of all GTA V / FiveM pickup hashes for weapons, ammo, and items. - [FiveM Profile Settings](): Look up Profile Settings identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [Radio Stations](): Complete reference of all GTA V / FiveM radio station names and identifiers. - [Ped Speeches](): Trigger GTA V ped voice lines in FiveM with ambient speech natives, speech names, and playback parameter options. - [Text Formatting](): Complete reference of GTA V / FiveM text formatting codes for notifications and UI. - [Vehicle Colours](): Complete reference of all GTA V / FiveM vehicle colour IDs with colour preview swatches. - [FiveM Vehicle Flags](): Look up Vehicle Flags identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [Vehicle Models](): Complete reference of all GTA V / FiveM vehicle model names, hashes, and categories. - [FiveM Vehicle References](): Look up Vehicle References identifiers and source-linked reference data for FiveM. Browse the full imported catalog and local examples. - [Weapon Models](): Complete reference of all GTA V / FiveM weapon hashes, categories, and stats. - [FiveM Zones](): Complete reference of all GTA V / FiveM zone names and their full location names. - [CitizenFX.ini: Find, Edit and Restore FiveM Settings](): Locate CitizenFX.ini, back it up, change the update channel safely, and distinguish game paths, build selection, overlays and private crash dumps. - [FiveM and RedM Prerequisites: Games, PCs and Plugins](): Choose a legitimate GTA V or Red Dead Redemption 2 PC installation, distinguish Legacy hardware figures from Enhanced, and understand local plugins and saves. - [FiveM Shortcuts: Launch Arguments and Safe Rollback](): Create a separate FiveM test shortcut, quote its executable path correctly, use Legacy launch flags deliberately, and undo changes without reinstalling. - [FiveM Crosshair Commands: Setup, Test and Reset](): Archived FiveM crosshair console commands, an optional F8 preset, server-policy cautions, and reset steps. Current client support is unverified. - [Finding Resources](): Where to legitimately find FiveM resources and how to vet them before installing them on your server. - [Install FiveM and Join Your First Server](): Install the FiveM Windows client, choose the correct GTA V edition, join with a server address, and distinguish player setup from running FXServer. - [FiveM Legacy vs Enhanced: Migration and Compatibility](): Plan a reversible FiveM Enhanced migration: check .NET, assets, escrow, voice, state storage, developer mode and server configuration before switching. - [FiveM License Key Setup (Cfx.re)](): Create a Cfx.re FiveM server license key in the Portal, configure sv\_licenseKey with txAdmin or server.cfg, and fix missing or invalid key errors. - [What Is FiveM? Server and Scripting Overview](): Learn what FiveM is, how custom servers and resources work, and what you need to create or develop a GTA V multiplayer server. - [FiveM vs RageMP vs AltV](): Verdict, quick comparison matrix, and guidance on which GTA V multiplayer platform to choose. - [How to Create a FiveM Server with txAdmin](): Set up a working FiveM server on Windows or Linux using current Cfx.re artifacts, Portal registration keys and the built-in txAdmin recipe deployer. - [FiveM Server Requirements: Windows, Linux and Ports](): Review supported FiveM server operating systems, sizing estimates, game ports, txAdmin access, license keys and optional SQL requirements before deployment. - [Set Up a Vanilla FiveM Server on Windows or Linux](): Install FXServer without txAdmin, separate binaries from server data, create a minimal server.cfg, choose the right track and verify the first connection. - [FiveM Artifact EOS, EOL and Server Support Timelines](): Understand FiveM end-of-support and end-of-life warnings, calculate the published support window, update safely, and report reproducible artifact regressions. - [FiveM Server Artifacts: Download and Update](): Download and safely update FiveM server artifacts on Windows or Linux, verify the new FXServer build, and roll back without replacing server data. - [Server Backups](): Database dumps, resource backups, and restore procedures for comprehensive FiveM server data protection - [How to Run a FiveM Server Using Docker](): Run a FiveM FXServer with Docker Compose and txAdmin on Linux. Set up persistent data, game ports, Cfx.re licensing, updates, backups, and troubleshooting. - [FiveM Featured Servers: Criteria and Reporting](): Understand the official featured-server criteria, curated selection, removal reasons and reporting process without confusing featuring with paid ranking. - [FiveM Server Hosting: VPS, Dedicated and Managed](): Choose a FiveM hosting provider with realistic CPU, RAM and network requirements, compare managed game hosting with VPS or dedicated servers and migrate safely. - [FiveM API Keys and Secret Configuration](): Configure Steam Web API keys, Discord bot tokens, webhooks, and resource secrets for FiveM without exposing credentials in Git, logs, or clients. - [Server Logging](): Implement structured logging, log rotation with logrotate, and ship logs to Grafana Loki for centralized monitoring - [Monetization with Tebex](): Set up a Tebex store and connect it to your FiveM server for package sales and donations - [FiveM Networking: Ports, Proxies, TLS and Server Listing](): Separate FiveM connection, game and file endpoints; configure TCP/UDP proxies and trusted headers; validate downloads, listing and firewall changes safely. - [FiveM OneSync: Scope, Ownership and Routing Buckets](): Use OneSync state awareness, server-created entities, orphan modes, routing buckets and lockdown without confusing client scope with server authority. - [Server Commands](): Reference for FXServer console commands run from the txAdmin console or server terminal - [Set Up a FiveM Tebex Store and Server Integration](): Complete Tebex onboarding, connect FXServer with a private secret, link the Cfx account, prepare fulfillment and submit a store for review. - [FiveM Voice: Legacy Mumble and Enhanced Channel APIs](): Configure Legacy Mumble or Enhanced voice, migrate channel membership to server APIs, apply submixes correctly, and test permissions, mute and cleanup. - [Asset Optimization](): Optimize streaming sizes, LODs, and ytyp rules for fast FiveM server downloads and performance - [Code Optimization](): Avoid while(true), throttling, and caching natives - [Performance Overview](): Introduction to FiveM server performance optimization - [Resource Monitor](): Read resmon results and set performance budget targets for optimal FiveM server resource management - [Performance Testing](): Load tests, synthetic peds/vehicles, and monitoring tools - [FiveM API Reference (HTTP & Server List)](): FiveM HTTP and server-list API reference: endpoint formats, integration examples, runtime services, authentication boundaries and deprecated APIs. - [FiveM Chat Exports: Messages, Hooks, Modes and Routing](): Use stock chat client/server exports with correct recipients, understand message-hook merging and cancellation, and register permission-scoped chat modes. - [Game References & Cheatsheets](): Quick references for Controls, Blips, Bones, and other common FiveM IDs. - [FiveM F8 Commands: Client Settings and Developer Tools](): Reference FiveM client commands, key bindings, saved settings, network and streaming diagnostics, gameplay switches and Enhanced-only tools with defaults. - [FiveM Client Events: Contracts and Safe Examples](): Find client event arguments, lifecycle timing, damage notifications, population hooks and cancellation rules, with scoped Lua examples. - [FiveM ConVars: set, setr, sets and Native Access](): Choose standard, replicated or public-info FiveM ConVars, read typed defaults, avoid exposing secrets, and diagnose permission or configuration mistakes. - [FiveM Cookbook Archive: Contracts and Migration Notes](): Review all 20 archived Cfx.re Cookbook articles with publication dates, practical contracts, corrected pitfalls and links to current FiveM guides. - [FiveM Documentation Coverage: Current Source Inventory](): Trace all 343 pinned upstream Markdown files to local guides, catalogs, historical reviews and explicit placeholder or generated-reference boundaries. - [FiveM Enhanced Migration: Breaking Changes Reference](): Audit Legacy-to-Enhanced changes in networking, IDs, state bags, .NET, assets, KVP storage, endpoints and developer tools before migrating a server. - [FiveM Game Event Payloads: IDs and Safe Diagnosis](): Inspect weapon damage, projectile, particle and vehicle events with bounded diagnostics, correct ID handling and no guessed payload offsets. - [FiveM Glossary](): Comprehensive reference of FiveM development terms and definitions for quick lookup - [FiveM JavaScript Events: onNet, emitNet and Exports](): Use JavaScript local and network events with the correct recipient argument, server source capture, bounded replies and resource exports in FiveM. - [FiveM JavaScript: setTick, clearTick and getPlayers](): Start and stop FiveM JavaScript ticks safely, handle tick ID zero, read server player IDs with getPlayers, and distinguish Cfx, Node and browser APIs. - [FiveM Limits](): Entity, file, streaming, and network limits in FiveM with optimization strategies - [FiveM Loading Screen Events: All Documented Payloads](): Use all eleven documented loading-screen messages, distinguish progress from initialization phases, render text safely and avoid false completion signals. - [FiveM Lua API: Events, HTTP, Players and Native Calls](): Look up CfxLua scheduling, event handlers, HTTP callback arguments, player identifiers, NUI helpers and vector constructors with context and failure rules. - [FiveM Manifest Entries, Constraints and Version History](): Reference every documented fxmanifest entry, glob rule, runtime constraint, FxDK ConVar descriptor and legacy manifest version with migration caveats. - [FiveM Natives Reference and Examples](): Search FiveM and Cfx natives by name, hash, namespace or client/server API set. Official GTA V and Cfx source data, signatures, examples and guides. - [FiveM Resource Manifest: Files, Dependencies and Flags](): Audit fxmanifest.lua file exposure, script contexts, dependencies, NUI assets, map declarations and runtime flags without copying obsolete manifest options. - [FiveM Runtime Internals and Undocumented Source APIs](): Inspect fxOM runtime interfaces, function references, native ABI boundaries and upstream placeholder APIs without treating incomplete sources as contracts. - [FiveM Sandbox: Files, Convars and Process Permissions](): Understand FiveM resource filesystem restrictions, directory handles, blocked OS calls, convar allowlists and explicit worker or child-process permissions. - [FiveM Server Commands and Configuration Reference](): Look up FXServer command syntax, ConVar defaults, game builds, pool limits, Enhanced settings, rate limiters, replay controls and security tradeoffs. - [FiveM Server Events: Arguments, Scope and Cancellation](): Look up server event signatures, implicit source, routing buckets, entity lifecycle and network requests without confusing handles or authority. - [FiveM Spawnmanager: Exports, IDs and Respawn Behavior](): Use all seven spawnmanager client exports with accurate JSON input, callback and ID behavior, a minimal spawn resource, and framework ownership warnings. - [FiveM Stock Resource Events: Context and Payload Guide](): Find baseevents, chat, mapmanager, sessionmanager and spawnmanager contracts, identify client versus server handlers, and avoid unsafe payload assumptions. - [FiveM Stock Resources: Dependencies and Mapmanager APIs](): Choose one owner for stock spawning and chat, configure mapmanager dependencies, understand map compatibility and inspect all seven mapmanager exports. - [baseevents](): Understand the built-in FiveM baseevents resource, its player and vehicle lifecycle events, payloads, and integration points. - [baseevents:enteredVehicle — Server Event](): Handle baseevents:enteredVehicle on the server, distinguish the client vehicle handle from its network ID, and validate observations before using them. - [baseevents:enteringAborted — Cancel Entry Observations](): Handle the server-side baseevents:enteringAborted report with no payload arguments and clear per-session entry observations safely. - [baseevents:enteringVehicle — Entry Attempt Report](): Read the four baseevents:enteringVehicle arguments on the server and distinguish an attempted vehicle entry from a completed, authorized action. - [baseevents:leftVehicle — Server Exit Observation](): Use baseevents:leftVehicle as a server-side client report, invalidate temporary vehicle state, and avoid trusting or broadcasting an unchecked network ID. - [baseevents:onPlayerDied — Death Notification Arguments](): Read baseevents:onPlayerDied on the client or server, distinguish killer type from player identity, and keep death presentation separate from rewards. - [baseevents:onPlayerKilled — Exact Payload and ID Meaning](): Use the actual lowercase baseevents deathData fields, interpret killerID as a server ID when available, and distinguish victim coordinates from attacker state. - [baseevents:onPlayerWasted — Legacy Fallback Contract](): Understand the one-argument baseevents:onPlayerWasted fallback, avoid treating it as a guaranteed death hook, and migrate to the actual provider lifecycle. - [chat resource](): Reference for the FiveM chat resource's NUI-based events and exports for sending messages, suggestions, templates, and modes. - [chat:addMessage: Targeted Messages and Template Fields](): Display a local or server-targeted FiveM chat message, distinguish templateId from inline template markup, and keep presentation separate from permissions. - [chat:addSuggestion](): Trigger the FiveM chat:addSuggestion event to register a single command autocomplete suggestion with parameter help text. - [chat:addSuggestions](): Trigger the FiveM chat:addSuggestions event to register multiple command autocomplete suggestions in a single call. - [chat:addTemplate: Register Trusted Chat Markup](): Register a static FiveM chat template, reference it with templateId, pass text through args and avoid injecting untrusted HTML into the chat UI. - [chat:clear](): Trigger the FiveM chat:clear event to wipe the local chat history and sent-message buffer. - [chat:removeSuggestion](): Trigger the FiveM chat:removeSuggestion event to remove a previously registered command autocomplete suggestion. - [chatMessage: Server Routing Hook and Client Migration](): Handle chatMessage locally on the server, understand synchronous cancellation, and use RegisterCommand or chat:addMessage for new integrations. - [addMessage (client)](): Call the FiveM chat client export addMessage to push a message into the local player's chat from a client script. - [addMessage (server)](): Call the FiveM chat server export addMessage to push a message into a specific player's or every player's chat. - [addSuggestion](): Call the FiveM chat export addSuggestion to register a command autocomplete suggestion from a client script. - [registerMessageHook](): Call the FiveM chat server export registerMessageHook to modify, cancel, or reroute outgoing chat messages. - [registerMode](): Call the FiveM chat server export registerMode to register a custom chat mode such as an admin-only channel. - [loadscreen](): Understand the FiveM loadscreen resource and how to point a server at a custom NUI connecting screen. - [mapmanager](): Reference for the FiveM mapmanager resource, its exports for managing maps and game types, and its client lifecycle events. - [getMapDirectives: Register and Clean Up a Map Directive](): Use mapmanager's add(name, create, remove) contract to register an original blip directive, retain its handle and remove it during map teardown. - [onClientGameTypeStart](): Handle the FiveM mapmanager onClientGameTypeStart event to react when a game type resource starts. - [onClientGameTypeStop: Game-Type Teardown Hook](): Use mapmanager's client game-type stop event for immediate, idempotent cleanup of owned state without assuming a universal post-cleanup barrier. - [onClientMapStart](): Handle the FiveM mapmanager onClientMapStart event to react when a map resource starts. - [onClientMapStop: Map Teardown Notification](): Handle mapmanager's client map-stop notification during teardown, clean up owned presentation state, and avoid assuming all map cleanup is finished. - [sessionmanager](): Reference for the FiveM sessionmanager resource, the built-in resource that manages player session state during connect and spawn. - [playerActivated: Sessionmanager Notification and Limits](): Handle the stock client playerActivated notification without assuming framework character data, inventory readiness or a universal initialization order. - [sessionInitialized: Client Session Notification](): Use sessionInitialized as a provider-specific client notification, avoid undocumented ped-readiness assumptions, and handle resource restarts explicitly. - [FiveM Spawnmanager Overview](): Use FiveM spawnmanager exports and events to configure spawn points, automatic spawning, custom callbacks, and respawns, with links to full contracts. - [playerSpawned](): Handle the FiveM spawnmanager playerSpawned event and use its position, heading, model, spawn index, and fade state. - [FiveM Map Animations: UV Tracks, Props and YCD Files](): Author UV scrolling and bone-animated FiveM props with Sollumz. Connect actions, clips, YCD dictionaries and YTYP flags, then diagnose missing animation. - [FiveM Asset Authoring: Original Mesh to Five Binary Formats](): Build an owned Blender prop with texture, collision and LODs, export YDR/YTD/YBN/YTYP/YMAP, inspect verified binaries and install a development fixture. - [FiveM Collision and LOD Diagnosis with Real Fault Fixtures](): Reproduce offset collision and incorrect low-LOD geometry using owned FiveM asset exports, compare measured bounds, and restore the verified fixture. - [FiveM Door Authoring: Hinges, Gates and Garage Doors](): Build swinging, sliding and vertical FiveM doors with correct origins, armature constraints, collision bounds and YTYP attributes in Blender and Sollumz. - [Build a Sollumz Asset Library for FiveM YMAP Work](): Create a local Sollumz game asset library, import a YMAP with its referenced models, diagnose incomplete extraction, and separate previews from game acceptance. - [Asset Streaming (Cars, Maps)](): How to stream custom vehicles, maps, and other assets in FiveM. - [CitizenMP.Server Migration: Historical Lua and CLR Changes](): Interpret the legacy CitizenMP.Server migration notes for script loading, Lua strings, bitwise operators, CLR exports and temporary player identifiers. - [FiveM C#: Async Tasks, Exports and NUI Callbacks](): Compile a CitizenFX C# client and server, cancel stale asynchronous work, expose a typed export and complete NUI callbacks exactly once. - [C# Scripting Basics](): A guide to getting started with C# scripting in FiveM, including project setup and basic syntax. - [Database Integration](): Use oxmysql and ghmattimysql with schema patterns and migrations for FiveM database operations - [FiveM Profiler: Record, Inspect, and Compare Captures](): Use profiler record, status, view, and saveJSON on a FiveM client or server, reproduce a slow action, and compare changes under the same conditions. - [FiveM Event Cancellation and Latent Event Delivery](): Understand CancelEvent and WasEventCanceled, send bounded latent events with the correct bps and target order, and test cancellation without false promises. - [FiveM Events: Client, Server, and Security](): Use TriggerEvent, TriggerServerEvent, TriggerClientEvent, RegisterNetEvent, and secure server-side validation for reliable FiveM resource events. - [Scripting Examples](): Ready-to-run mini resources and code examples for FiveM development starters - [Resource Exports](): Define and consume exports with namespacing patterns for inter-resource communication in FiveM - [Your First FiveM Lua Resource: Setup to Vehicle Spawner](): Create and restart a FiveM Lua resource, distinguish client/server consoles, validate a vehicle model, bound loading and clean up the demo on shutdown. - [Your First FiveM C# Resource: Build, Spawn and Debug](): Build a complete C# client resource with pinned assemblies, bounded model loading, task error handling, shutdown cleanup and matching debug symbols. - [Your First FiveM JavaScript Resource and Vehicle Demo](): Create a FiveM JavaScript resource with a manifest, client and server scripts, bounded model loading, correct hash cleanup and repeatable test cases. - [FiveM JavaScript: Async I/O, Sessions and C# Exports](): Build a Node 22 FiveM resource with safe I/O scheduler handoff, request timeouts, session-reuse protection and a compiled C# export. - [JavaScript Basics](): Learn JavaScript fundamentals and patterns for FiveM scripting and resource development - [FiveM Key Bindings with RegisterKeyMapping](): Create remappable FiveM controls in Lua, distinguish press and hold commands, test saved player bindings, and avoid polling every frame for a key. - [Lua Basics](): Learn Lua fundamentals and common patterns for FiveM scripting and resource development - [FiveM Lua Threads, Wait, Timers, and Async Source](): Choose between CreateThread, Wait, and SetTimeout in FiveM Lua. Build cancellable timers, avoid blocking loops, and preserve source across async work. - [FiveM Lua Vectors, Distance and Quaternion Rotation](): Use vector2, vector3, vector4, dot, cross, norm, quat and slerp in FiveM Lua, with zero-length guards, rotation ordering and a runnable math check. - [Migrating from Deprecated FiveM APIs](): Move off deprecated FiveM scripting patterns — raw chatMessage events and unrestricted RegisterCommand — to chat:addMessage and ACE-aware command restriction. - [FiveM IDs: Players, Peds, Entity Handles and Network IDs](): Convert player indexes, server session IDs, local entity handles and entity network IDs on the right side, accounting for scope, reuse and disconnects. - [FiveM NUI: Messages, Focus, and Callbacks](): Build a FiveM NUI resource with fxmanifest.lua, SendNUIMessage, SetNuiFocus, browser message handlers, and reliable Lua NUI callbacks. - [Advanced FiveM NUI: DUI, Focus, and Loading Screens](): Build a local DUI texture with cleanup, release NUI focus reliably, and display real loading progress using eventName and loadFraction. - [FiveM NUI Callbacks: Current Lua, JS and C# APIs](): Register current NUI callbacks in Lua, JavaScript and C#, validate JSON requests, finish every response and handle browser timeouts without hanging UI. - [FiveM Scripting: Runtimes, Context and First Resources](): Choose Lua, JavaScript or C#, separate client, server and NUI code, find native contracts and diagnose slow resources with the correct track's tools. - [ox\_lib Integration](): Use ox\_lib for callbacks, context menus, notifications, and locales in FiveM resources - [Migrate GTA Multiplayer Resources to FiveM](): Map other platforms' entities, dimensions, RPC, storage, identifiers and ownership to FiveM while accounting for Legacy and Enhanced runtime differences. - [FiveM Connection Deferrals: Build a Safe Allowlist](): Build a server-side playerConnecting allowlist with valid deferral timing, private JSON configuration, clear rejection messages, and failure tests. - [Resource Lifecycle](): Understand fxmanifest, ensure, start, stop commands and lifecycle events for FiveM resources - [FiveM Resource Storage and Sandbox-Safe JSON Files](): Read and save server-only resource settings with LoadResourceFile and SaveResourceFile, validate JSON, handle failures, and respect FiveM's sandbox. - [FiveM Scaleform: Custom GFx, Methods and Safe Cleanup](): Load and draw FiveM Scaleform movies, pass typed arguments, author custom ActionScript 2 GFx, use textures and masks, and release handles safely. - [FiveM State Bags: Replication, Ownership and Strict Mode](): Use entity, player and global state bags with explicit replication, shallow keys, owner permissions, strict mode and safe change-handler lifecycles. - [FiveM Ped Collections: Drawable and Prop Native Reference](): Store stable collection names and local clothing indexes, convert older global indexes and use all documented collection-based ped component and prop APIs. - [FiveM Fuel Consumption: Rates, Tanks and Safe Refuelling](): Enable built-in fuel consumption, tune global and per-vehicle rates, read tank capacity and separate client refuelling demonstrations from server purchases. - [Anti-Cheat Basics](): Learn anti-cheat concepts, validation techniques, and false positive management for FiveM servers - [FiveM Asset Escrow: Formats, Entitlements and Updates](): Create and update escrow assets through Cfx Portal, preserve editable configuration, distribute via Tebex, and diagnose entitlement and compatibility issues. - [Common Security Risks](): Event injection, eval, and SQL injection prevention - [Legal Considerations](): Understand FiveM license requirements, asset licensing, and copyright basics for server operators - [FiveM ACE Permissions: Grant, Test, and Revoke Access](): Configure least-privilege FiveM ACE rules, protect a server command, test effective permissions, and diagnose inherited deny rules without blanket grants. - [Secure FiveM Events: Validate Requests on the Server](): Build a validated FiveM client-to-server request with a strict payload, ACE check, rate limit, disconnect cleanup, and tests for malicious input. - [fxmanifest Snippets](): Ready-to-use fxmanifest configurations for base, NUI, and shared script setups - [JavaScript Snippets](): Common JavaScript patterns including fetch and postMessage bridge for FiveM resources - [Lua Snippets](): Common Lua server and client patterns for QBCore and ESX frameworks - [Operations Snippets](): Ready-to-use systemd, nginx reverse proxy, and backup configurations for FiveM servers - [SQL Snippets](): User tables, indexes, and common SQL patterns for FiveM database schemas - [Connect FiveM Docs to AI Assistants](): Connect MCP clients or a Custom GPT to public FiveM guides, search the documentation, read source text, and cite canonical documentation links. - [Alchemist for FiveM: Convert Assets Without Losing Sources](): Plan Legacy-to-Enhanced conversion with AlchemistCli, separate refinement from conversion, preserve originals and validate supported asset formats. - [Server Analytics](): Track server metrics with Sentry, Plausible, and GameEvents for FiveM monitoring - [Database Setup](): Set up MariaDB, oxmysql, and PostgreSQL for FiveM server data persistence - [Discord Integration](): Set up Discord bots, Rich Presence, and role sync for FiveM server community features - [FXCode: Edit, Build and Diagnose FiveM Resources](): Use FXCode inside FxDK, distinguish language hints from runtime support, diagnose client/server errors and verify the compiled resource outside the editor. - [FxDK for FiveM: Local Projects and Runtime Boundaries](): Use FxDK on Windows for an isolated FiveM development project, identify its limitations, and choose the right build and multiplayer testing workflow. - [Build a FiveM FxDK Project with Verified Resource Output](): Compile a real JS/C# resource through an FxDK build hook, exclude source files correctly, inspect generated configuration and hand off a clean server build. - [Script Resources](): Find free and premium FiveM scripts, mods, and resources for QBCore, ESX, Qbox, and Standalone servers - [Two FiveM Clients: Legacy and Enhanced Test Workflows](): Test synchronization with two local FiveM clients using Legacy -cl2 or Enhanced development mode, with isolated identities, failure cases and cleanup. - [Contribute to Cfx.re Docs: Forks, Rebase and Squash](): Choose the right Cfx.re repository, follow its documentation policy, create a focused pull request and update your own branch without overwriting others. - [VS Code Setup for FiveM](): Complete guide to setting up VS Code for FiveM with extensions, debugging, and IntelliSense - [FxDK World Editor: Patches, Additions and Script Events](): Use FxDK World Editor patches and additions, understand collision limits, compile map assets and handle creation/deletion events without stale entities. - [FiveM Troubleshooting Checklists](): Diagnose FiveM startup, player connections, SQL, and resource errors with actionable checklists, safe commands, and current Cfx.re and txAdmin guidance. - [FiveM Client Diagnostics: Crashes, F8, and Slow Frames](): Separate client crashes from server failures, collect a useful F8 report, measure performance, and handle full memory dumps without exposing private data. - [FiveM Common Errors and Fixes](): Fix FiveM license, startup, connection, escrow, database and framework errors with current Cfx.re Portal paths and safe troubleshooting procedures. - [FiveM Platform Support: Crashes, Startup and Dumps](): Route FiveM client, server and resource issues correctly, collect private crash evidence, diagnose installation failures and undo diagnostic changes safely. - [txAdmin Backups: Protect Server Data and Databases](): Back up FiveM txAdmin profiles, resource files, and external MariaDB data; test restores and avoid assuming txAdmin is a complete backup platform. - [txAdmin Recipe Deployer vs Git CI/CD](): Understand what txAdmin's one-time recipe deployer actually does, how to deploy a FiveM framework safely, and where external Git automation is needed. - [txAdmin Discord Integration: Status and Whitelist](): Use txAdmin Discord integration for server status, whitelist workflows, and player information without inventing commands or automatic role sync. - [txAdmin First Run: PIN, Cfx.re Login and Recipe](): Complete the current txAdmin first-run wizard: enter the console PIN, link your Cfx.re account, set a backup password, deploy a recipe and verify startup. - [Install txAdmin with FXServer on Windows or Linux](): Install the current FiveM FXServer artifact on Windows or Linux, launch bundled txAdmin in monitor mode, and access its first-run wizard safely. - [Monitor FXServer with txAdmin and External Alerts](): Use actual txAdmin dashboards, live console and crash recovery to monitor FiveM servers, and configure external uptime or resource alerts where needed. - [txAdmin Guide for FiveM Server Management](): Complete txAdmin guide for FiveM: setup, port 40120, live console, player management, scheduled restarts, recipes, permissions, security, and troubleshooting. - [txAdmin Permissions: Admin Manager and Access Reference](): Configure txAdmin's actual permission identifiers in Admin Manager, distinguish them from ACE permissions, test least-privilege access and revoke accounts. - [txAdmin Recipes: Deploy FiveM Frameworks Safely](): Use the txAdmin Recipe Deployer to install CFX, QBCore, ESX or Qbox templates, validate database tasks and update resources without overwriting production. - [txAdmin Security: Private Access and Least Privilege](): Secure txAdmin with private network access, Cfx.re account protection, backup passwords, limited administrator permissions, and safe logging. - [txAdmin Troubleshooting: Startup, Ports and Recipes](): Diagnose txAdmin startup, license keys, blocked administration access, port conflicts, and recipe failures without unsafe shutdown or firewall commands. ## Primary references - [Cfx.re documentation](https://docs.fivem.net/docs/) - [FiveM native reference](https://docs.fivem.net/natives/)