fxmanifest.lua complete guide

Every FiveM resource must have fxmanifest.lua as its primary entry point. This file tells FiveM what your resource does, what it needs, and what files it contains.

Basic Structure

fx_version 'cerulean' -- version of FiveM manifest format
game 'gta5' -- gta5 or rdr3

author 'YourName'
description 'Resource description'
version '1.0.0'

Scripts

-- Server scripts
server_scripts {
    '@oxmysql/lib/MySQL.lua', -- insert @ = shared resource
    'config.lua',
    'server/*.lua'
}

-- Client scripts
client_scripts {
    'config.lua',
    'client/*.lua'
}

-- Shared scripts (load both client and server)
shared_scripts {
    '@es_extended/imports.lua',
    'config.lua'
}

Dependencies

dependencies {
    'es_extended', -- ESX must be started first.
    'oxmysql',
    '/server:6116', -- requires this server version or higher.
    '/onesync' -- requires OneSync to be turned on.
}

NUI (HTML Interface)

ui_page 'ui/index.html'

files {
    'ui/index.html',
    'ui/style.css',
    'ui/app.js',
    'ui/img/*.png' -- glob patterns supported
}

Data Files

-- Add handling data for vehicle
data_file 'HANDLING_FILE' 'data/handling.meta'
data_file 'VEHICLE_METADATA_FILE' 'data/vehicles.meta'
data_file 'CARCOLS_FILE' 'data/carcols.meta'

Exports

-- Declare exports that can be called by other resources.
exports { 'GetPlayerData', 'IsPlayerAdmin' }
server_exports { 'GetAllPlayers', 'GetPlayerIdentifier' }

Lua54

lua54 'yes' -- Enable Lua 5.4 (recommended)
-- got integer division (//), bitwise operators, to-be-closed variables

Complete example

fx_version 'cerulean'
game 'gta5'

author 'M2Dev'
description 'Custom Job Script'
version '2.1.0'

lua54 'yes'

dependencies {
    'es_extended',
    'oxmysql'
}

shared_scripts {
    '@es_extended/imports.lua',
    'config.lua'
}

server_scripts {
    '@oxmysql/lib/MySQL.lua',
    'server/main.lua',
    'server/callbacks.lua'
}

client_scripts {
    'client/main.lua',
    'client/ui.lua'
}

ui_page 'ui/index.html'

files {
    'ui/index.html',
    'ui/style.css',
    'ui/app.js'
}

exports { 'IsOnDuty', 'GetJobData' }

Common Errors

Summary

fxmanifest.lua A good resource is the foundation of good resources. Understand every field and you will avoid common errors and deploy scripts with confidence.