Skip to Content
Report an error
Open in ChatGPTOpen in Claude

What are you trying to do in FiveM?

Choose a task instead of guessing an API category. These are independent FiveM Docs guides with primary-source links and stated verification limits, not the official Cfx.re documentation.

I want to play or fix my client

Your questionStart here
How do I install FiveM and join a server?Client installation and first connection
Which GTA edition or FiveM track should I use?Legacy versus Enhanced and migration blockers
Where is CitizenFX.ini, and how do I undo an edit?Client configuration and backups
Where do launch arguments go?Test shortcuts and rollback
How do I change or disable the built-in crosshair?Crosshair setup and reset
FiveM crashes or a server will not load. What should I collect?Client diagnostics, F8 and private crash reports
Why does a key work for another player but not for me?Saved key bindings and conflicts

A player normally does not need a server license key, database or txAdmin. Follow the client workflow before changing unrelated server settings.

I want to run or migrate a server

Your questionStart here
How do I create a working server?txAdmin quick start
Where do I get a server license key?License-key setup
Why can local players connect but remote players cannot?Server networking
How do I update without losing data?Artifacts and backups
What blocks a Legacy-to-Enhanced move?Runtime, asset, escrow, voice and state migration checklist
How do I allow one command without full admin?Grant, test and revoke ACE permissions
How do I approve players before entry?Connection deferrals and allowlists
Why did startup fail?Common errors and checklists
Why are players or entities not synchronized?OneSync and network IDs
Where do I configure voice?Voice setup, checked against the chosen track

I want to build or debug a resource

Your questionStart here
Which files belong in a resource?Manifest example and resource lifecycle
Which manifest fields expose files or require a runtime feature?Manifest fields, dependencies and flags
How do Lua threads, Wait and timers work?Lua scheduling and async source
How do I calculate distance, directions or quaternion blends?Lua vectors and rotation helpers
How do I stop duplicate ticks or list server players in JavaScript?setTick, clearTick and getPlayers
Why does a Node I/O callback fail when it calls a native?JavaScript scheduler handoff and session-safe replies
How do I compile a C# export and finish NUI callbacks?C# tasks, exports and exactly-once callbacks
What arguments does an engine event actually provide?Client contracts and server contracts
What do damage or projectile fields actually mean?Named game-event payloads and bounded diagnosis
Is baseevents or chat running this handler locally or on the server?Stock-resource event directory
Why do spawnmanager IDs, callbacks or forced respawns behave differently?All seven spawnmanager exports
How do client and server scripts communicate?Events and exports
Does cancellation stop other handlers, and when should I use latent events?Cancellation and bounded latent delivery
How do I stop forged privileged requests?Server-validated network requests
How do I replicate state or store settings?State bags, private resource storage and database access
How do I close a menu without trapping input?NUI basics and focus cleanup
Which loading-screen message fields are documented?All eleven loading-screen contracts
How do I let players rebind controls?RegisterKeyMapping examples
Which function caused the slowdown?Record and compare profiler captures

I need an actual asset or tooling walkthrough

Your questionStart here
How do I turn my own mesh into streamed files?Owned asset-authoring lab with downloads
Why is collision offset or a distant LOD the wrong shape?Real collision and LOD fault fixtures
How do I resolve a YMAP’s referenced models without importing each manually?Build and verify a Sollumz asset library
How do I place existing world objects?World Editor and streaming basics
Can I use FxDK on this machine and invite other players?FxDK platform and single-user boundaries
How do I inspect code in the integrated editor?FXCode edit-build-observe workflow
How do I compile and export a project?FxDK build hook and verified resource output
How do I run two test clients?Legacy and Enhanced two-client workflows
How do I convert assets without overwriting originals?Alchemist GUI/CLI and conversion limits

For language fundamentals, use the JavaScript first resource or C# first resource. For an individual native signature, use native API context and the official native reference .

Search by the symptom or exact function name

Search for playerConnecting, weaponDamageEvent, loadFraction, SaveResourceFile, CitizenFX.ini or the first complete error. Remove private identifiers/tokens before sharing diagnostics. The report template records expected behavior, reproduction, environment and evidence.

The pinned coverage inventory identifies covered, partial and deferred source topics without a misleading parity percentage. /llms.txt is generated from public route metadata; it is a discovery aid, not a replacement for reading the source or proof of search/AI ranking. Compilation and parser checks are distinguished from actual FiveM engine acceptance in each relevant example.

Additional source-backed references

TopicReference
Lua API ReferenceOpen guide
JavaScript Events & ExportsOpen guide
Runtime Internals & Source LimitsOpen guide
Manifest Entry CatalogOpen guide
Client Console CommandsOpen guide
Server ConfigurationOpen guide
Sandbox & PermissionsOpen guide
Enhanced Breaking ChangesOpen guide
Chat Exports & RoutingOpen guide
Stock Resource SetupOpen guide
Cookbook Archive ReviewOpen guide
First Lua ResourceOpen guide
NUI Callback APIsOpen guide
Porting Other PlatformsOpen guide
Historical CitizenMP MigrationOpen guide
Animated Asset AuthoringOpen guide
Functional Door AuthoringOpen guide
Games & Client PrerequisitesOpen guide
Vanilla Server SetupOpen guide
Artifact Support PolicyOpen guide
Featured Server RequirementsOpen guide
Tebex SetupOpen guide
Contribute to Cfx.re DocsOpen guide
Platform Support & DiagnosticsOpen guide
C# first projectBuild, spawn and debug
JavaScript first resourceBounded client and server examples
Stable clothing identifiersCollection-based natives
Fuel and refuellingConsumption and transaction boundaries