fxmanifest.lua Generator

Generate a valid fxmanifest.lua for any FiveM or RedM resource: shared/client/server scripts, NUI page, files, dependencies, exports and lua54.

Config & CodeResource, DownloadRead the docs

Start from

Resource

fx_version

Game

NameAuthorVersionRepositoryDescription

lua54 'yes'Lua 5.4 runtime. Required by ox_lib and most modern resources.use_experimental_fxv2_oalExperimental faster native calls for Lua 5.4. Test your resource before shipping it.

Scripts

shared_scripts

client_scripts

server_scripts

NUI & files

ui_pagePath inside the resource, or an http(s) URL for a dev server.

files

Files sent to clients. Globs like ** are supported.

Add ui_page and data_file paths to files automaticallyBoth must be in files { } or clients never download them.

data_file

Dependencies & exports

dependencies

Resources that must start first. /onesync, /server:<artifact> and /gameBuild:<build> set server requirements.

provideLets this resource stand in for another one (e.g. a mysql-async replacement).

exports (client)

Only needed for old style exports. exports('name', fn) in Lua works without this.

server_exports

escrow_ignore

Files left readable when the resource is uploaded to the Cfx.re asset escrow.

fxmanifest.lua

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

name 'my_script'
description 'Basic client/server script'
version '1.0.0'

shared_scripts {
    'config.lua',
}

client_scripts {
    'client/*.lua',
}

server_scripts {
    'server/*.lua',
}

How to use it

Pick a starting point: Basic script, NUI resource or Vehicle pack.
Add or remove scripts. The small + @ox_lib/init.lua style buttons add common framework imports.
Download fxmanifest.lua into your resource folder and ensure the resource in server.cfg.

Your manifest is saved in this browser, so you can come back and tweak it.

Load order

Scripts load in the order they are listed, and shared_scripts load before client and server scripts on each side. That is why @ox_lib/init.lua or @qbx_core/modules/lib.lua go at the top of shared_scripts, and config.lua should come before any file that reads Config. Paths starting with @ point into another resource, which needs to be started first (list it in dependencies).

A typical Qbox / ox_lib manifest

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

name 'my_job'
version '1.0.0'

shared_scripts {
    '@ox_lib/init.lua',
    '@qbx_core/modules/lib.lua',
    'config.lua',
}

client_scripts {
    '@qbx_core/modules/playerdata.lua',
    'client/*.lua',
}

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

dependencies {
    'ox_lib',
    'qbx_core',
    'oxmysql',
}

Vehicle packs

Put models (.yft, .ytd) in a stream folder, they are streamed automatically. Meta files need two things: a files entry so clients download them, and a data_file line so the game loads them. Globs such as data/**/vehicles.meta let you keep one folder per car.

Gotchas

ui_page must also be in files, or the NUI frame stays blank. The generator adds it for you.
fxmanifest.lua replaced the old __resource.lua. Do not ship both.
RedM resources need game 'rdr3' plus the exact rdr3_warning line, which is added automatically.
Changing the manifest requires refresh then ensure your_resource in the server console.