Docs / Games / FiveM
FiveM

FiveM

GTA V role-playing modification framework. Complete guide to server setup, scripting, and community management.

Overview

Base Game: Grand Theft Auto V

Platform: Windows PC only (requires GTA V)

Scripting: Lua, C#, JavaScript

Database: MySQL or MariaDB support

Max Players: 256+ per server

System Requirements

Minimum

  • OS: Windows 10/11 64-bit
  • CPU: Intel i5-5000 / Ryzen 5
  • RAM: 4GB minimum (8GB+)
  • Storage: 70GB (GTA V)
  • Connection: 50Mbps upload

Recommended

  • OS: Windows 10/11 64-bit
  • CPU: Intel i7 / Ryzen 7
  • RAM: 16GB+
  • Storage: 100GB NVMe SSD
  • Connection: 100Mbps+ upload

Installation Guide

1

Install FiveM Client

Download and install FiveM launcher from fivem.net

2

Prepare Server Files

Download FiveM server artifacts and extract to directory

3

Configure Resources

Add resources and edit server.cfg with settings

4

Start Server

Run FxServer.exe or batch script to launch server

Server Configuration

# server.cfg
server_name "My FiveM Server"
description "Welcome to our FiveM server!"
sv_maxclients 32
setr -1 1
setr sv_lan 0
start mysql-async
start essentialmode
start es_admin2

Common Bugs & Issues

Server Won't Start

Resource has errors or config syntax incorrect. Check console.log for details.

Database Connection Failed

MySQL credentials wrong or server unreachable. Verify connection details.

Script Errors on Players

Resource Lua/C# code errors. Enable debug mode and check logs.

Players Kicked for Desync

Network synchronization issues. Reduce player count or server resources.

Troubleshooting

Server Crashes

  • Check console.log for crash reasons
  • Disable recently added resources
  • Update FiveM to latest version
  • Monitor memory and CPU usage

Lag & Performance Issues

  • Optimize Lua scripts for performance
  • Reduce update frequency for streaming entities
  • Use native code (C#) for heavy operations
  • Check MySQL query performance

Performance Optimization

💻 Script Optimization

  • Use coroutines for intensive tasks
  • Cache data when possible
  • Avoid frequent database queries
  • Use native functions

🗄️ Database Optimization

  • Index frequently queried columns
  • Implement connection pooling
  • Archive old data regularly
  • Monitor slow queries

Resource Development

FiveM resources can be written in Lua, C#, or JavaScript for maximum flexibility.

Popular Frameworks

ESX, vRP, Luxart Vehicle Control, RedM

Development Tools

Visual Studio Code, Lua LSP, Resource templates

Advanced Troubleshooting

Database Connection & Query Debugging

-- Enable query profiling in mysql-async
TriggerEvent('mysql-async:debug', true)

-- Check connection pooling (max_connections mismatch)
SET GLOBAL max_connections = 500;
SHOW PROCESSLIST;

-- Identify slow queries
SET GLOBAL slow_query_log = 'ON';
SET GLOBAL long_query_time = 1;
SELECT * FROM mysql.slow_log;

-- Monitor active connections
SHOW STATUS WHERE variable_name LIKE 'Threads%';
  • Connection Pool Exhaustion: Increase mysql-async pool size. Default 5 often insufficient for large players
  • Query Timeouts: Optimize WHERE clauses, add indexes on frequently queried columns
  • Deadlocks: Use transactions carefully, maintain consistent lock ordering across resources
  • Character Encoding: Ensure latin1 or utf8mb4 consistency between server and database

Resource Event Tracing & NUI Communication

-- Monitor inter-resource events
AddEventHandler('onResourceStart', function(resource)
  print('Resource ' .. resource .. ' started')
end)

-- NUI Callback debugging
RegisterNUICallback('eventName', function(data, cb)
  print('NUI Event: ' .. json.encode(data))
  cb('ok')
end)

-- Check event queue saturation
GetTxnExecutiontime() < 10 or print('Event saturation detected')
  • Event Flooding: Use debounce functions, check for recursive triggers in logs
  • NUI Freezes: Profile JavaScript execution with DevTools (F11), optimize DOM manipulation
  • Silent Callback Failures: Add error handlers, log all NUI communication
  • Script Timeout: Break long operations into async chunks or separate threads

Asynchronous Code & Network Debugging

-- Debug async operations
Citizen.CreateThread(function()
  print('Thread started at ' .. GetGameTimer())
  Wait(1000)
  print('Thread resumed after 1s')
end)

-- Network debug logging
SetConvarReplicated('debug_net', 'true')
print('Network tick: ' .. GetGameTimer() .. 'ms')

-- Measure RPC latency
local start = GetGameTimer()
TriggerServerEvent('myevent', data)
-- Calculate latency in callback
  • Desync Issues: Sync objects via ObjState not SetEntityState for position updates. Use entity lockdown
  • RPC Delays: Batch net events, use broadcast radius filtering for TriggerClientEvent
  • Thread Blocking: Avoid nested Wait() calls, use separate threads for independent operations
  • Memory Leaks: Close NUI listeners on resource start, clean up event handlers

Performance Profiling & Bottleneck Identification

-- Check resource CPU usage
Resource.GetCurrent():GetCpuTime() -- milliseconds

-- Monitor entity spawning overhead
local entities = GetGamePool('CObject')
print('Active objects: ' .. #entities)

-- Check streamer state (distance loading)
Citizen.Wait(100)
local loaded = GetEntityCoords(PlayerPedId())
  • Frame Rate Drops: Use profiler to identify expensive loops, reduce entity density near players
  • Streaming Issues: Check InteriorProxy usage, reduce draw distance modifiers
  • Scripting Overhead: Replace global loops with targeted event-based triggers
  • Network Saturation: Monitor NetLibrary bandwidth, reduce sync frequency for non-critical data

Authentication Failures & Anticheat False Positives

-- Server logs anticheat bypass attempts
[ 1234] ANTICHEAT: Suspicious call detected from source 123
[ 1235] AUTH: License not found for player

-- Check client version compatibility
SetRoutingBucket(player, bucket)
-- Verify client build version matches
  • License Errors: Verify Cfx.re account linked, check live tag active, clear browser cache
  • Version Mismatch: Force client update, check txAdmin for correct artifact (latest built)
  • False Ban Kicks: Review server.log for specific violation, contest in FiveM forums if legitimate
  • Resource Suspicion: Ensure all natives used are whitelisted, avoid deprecated functions

Pro tip: Always enable structured logging. Add timestamps to all debug output. Use txAdmin for centralized log aggregation.

Developer Resources

Native Functions

Access to 3000+ GTA V natives for custom gameplay

Resource API

Comprehensive API for inter-resource communication and data management

Package Management

cfxjs ecosystem for dependency management and resource organizations

FAQ

Why was my server banned?

Common reasons: exploits, pay-to-win mechanics, or ToS violations. Check FiveM forums for guidelines.

How do I back up my server data?

Export MySQL database daily and backup resource files to external storage.