How to Write and Check a FiveM fxmanifest.lua

[fivemx_fxmanifest_tool]

An fxmanifest.lua belongs at the root of a FiveM resource. It declares the supported game, scripts, dependencies and client-delivered files. Choose the example that matches your resource and replace every example filename with a file that actually exists.

The configuration and code examples here target FiveM for GTA V Legacy. Enhanced has different runtime and compatibility rules; check Cfx.re’s Legacy-to-Enhanced changes before applying them to an Enhanced server.

A minimal script resource

fx_version 'cerulean'
game 'gta5'

client_script 'client.lua'
server_script 'server.lua'

Use client_script for code running on each player’s client and server_script for FXServer code. Add author, description and version metadata when useful. A dependency may inspect your version, but version metadata does not itself change execution. Current CfxLua uses Lua 5.4; the lua54 switch is deprecated.

Shared files and dependencies

fx_version 'cerulean'
game 'gta5'

dependencies { 'ox_lib', 'oxmysql' }
shared_scripts { '@ox_lib/init.lua', 'config.lua' }
client_scripts { 'client/*.lua' }
server_scripts { '@oxmysql/lib/MySQL.lua', 'server/*.lua' }

This example requires the named libraries; omit them when your resource does not use them. Shared scripts are delivered to clients, so keep credentials, webhooks and server-only authority checks out of shared files. Declare the dependencies your code actually needs and follow their documented startup order.

A browser interface with NUI

fx_version 'cerulean'
game 'gta5'

ui_page 'web/index.html'
files { 'web/index.html', 'web/style.css', 'web/app.js' }
client_script 'client.lua'

List every required local UI asset, including fonts and images. A blank interface requires checking both its page path and missing assets. A loading screen uses loadscreen and its own lifecycle instead of this ui_page example.

Maps and additional archetypes

fx_version 'cerulean'
game 'gta5'

this_is_a_map 'yes'
files { 'stream/example.ytyp' }
data_file 'DLC_ITYP_REQUEST' 'stream/example.ytyp'

Put streamable assets in stream. The YTYP registration shown here is for a resource containing that file; a simple YMAP-only resource does not need a fictitious YTYP. Use the data-file declaration required by the actual asset type.

Start and verify

1. Check that the folder contains fxmanifest.lua directly and that all paths match the actual filenames, including case.
2. Install the declared dependencies. Add ensure followed by the resource-folder name to server.cfg after the documented dependencies.
3. Run refresh and ensure resource-name in the development server console, substituting your folder name. Read the first startup error.
4. Join, exercise the resource and inspect F8 as well as the server console. Test a full server restart to catch dependency and packaging errors hidden by hot reloads.

Common errors

Missing file: compare the exact manifest path and filename. Missing export: check dependency version and initialization order. Secrets visible to clients: move them out of shared/client files and rotate exposed values.

Do not shorten a vendor manifest by copying this tutorial over it. Use the official manifest reference and data-file reference to understand each declaration before changing it.

What should I check in a purchased resource manifest?

Compare the declared dependencies and build requirements with your server before starting the resource. Check that referenced scripts and interface files are present. A valid manifest describes what to load; it does not certify the resource’s gameplay, performance or framework integration.

Cfx.re manifest reference

View the package requirements for ESX Server Base (by RibSosay)

Compare two FiveM resources before buying

Choose the exact resource version that meets the requirements you cannot compromise on: your server setup, the changes you need to make and your access terms. Use the worksheet below to compare evidence for two candidates. An unanswered field stays unknown; it does not become a compatibility claim or an automatic rejection.

This worksheet is for server operators choosing a resource and developers checking an integration. It builds on the manifest and file checks above. A product title, framework badge or preview cannot fill in the version-specific answers.

A worksheet for eight purchase decisions

Replace Candidate A and Candidate B with the resource names and exact versions. Write “not applicable” only after confirming that a condition does not apply. Keep the supporting installation page, seller answer or permitted test result beside your record.

Purchase decision	Evidence to record for the version being sold	Candidate A / Candidate B
1. Is this the package I intend to install?	Exact version; included resource folders and files; installation instructions for that version. Compare declarations with the delivered file tree when available.	A: Unknown B: Unknown
2. Can my server meet its prerequisites?	Required dependencies and versions; relevant server/game build or runtime conditions; your corresponding installed values. Ask about undeclared prerequisites too.	A: Unknown B: Unknown
3. Can I make the changes I need?	The specific editable files and supported extension points for your intended change, together with the supplied terms.	A: Unknown B: Unknown
4. Does the evidence cover my game edition?	Explicit Legacy or Enhanced scope and evidence for that edition. Record any unresolved limitation.	A: Unknown B: Unknown
5. What access am I purchasing?	Applicable entitlement requirements; access duration and any subscription expiry; documented installation and update access.	A: Unknown B: Unknown
6. Does the interface fit my setup?	For a resource with NUI: local UI files or an external UI host, and the installation/support requirements for that arrangement.	A: Unknown B: Unknown
7. Is my framework integration supported?	Supported framework/version and integration path; relevant inventory, dispatch or other dependency versions. Identify adaptations you would have to maintain.	A: Unknown B: Unknown
8. Is there evidence for my required workflow?	A version-specific result for the workflow you need, the setup tested and remaining failures. If you are permitted to test, record startup, a full restart and the actual integration action.	A: Not tested B: Not tested

The record requests are editorial suggestions. They are not findings about a particular package. Prioritize the rows that affect your decision: editable job logic may be essential for one project, while a map installation has different questions.

How to interpret the answers

Requirements: The Cfx.re manifest reference documents resource dependencies and optional runtime constraints. A dependency name alone does not establish its required version. Do not turn an example build number or every supported constraint into a universal requirement.

Editing and access: Cfx.re’s Asset Escrow documentation describes excluded files, entitlements and subscription expiry. Those conditions apply where that access model is used. An editable config does not establish complete source access or permission for every modification.

Edition: As checked on 9 October 2026, Cfx.re’s Legacy-to-Enhanced changes page lists Asset Escrow as not implemented for Enhanced. Recheck that dated limitation before relying on an escrow resource for Enhanced. This worksheet is not an Enhanced compatibility list.

Interface and framework: The NUI documentation supports local and external UI pages; neither arrangement proves a particular interface works. Qbox’s FAQ describes QBCore bridge exceptions involving API use, internal files and direct database access. Use the Qbox versus QBCore guide for the related framework choice, then obtain evidence for the resource version you want.

Common buyer questions

Does “standalone” establish that there are no dependencies?

Record the actual dependency list and versioned installation instructions rather than filling the worksheet from the label.

Does a passing manifest check prove the resource works with my stack?

The declaration is one input. Startup and the workflow connecting your resource to inventory, dispatch or persistence require separate evidence. The worksheet does not certify performance, security or gameplay behavior.

What should I do with an unanswered field?

Decide whether it is essential to your project. Ask a specific question before committing if it is. Keep seller claims, documentation checks and observed test results distinct.

Ask a question the seller can answer

I use [edition], [framework/version] and [relevant dependency versions]. I need to change [specific behavior] and run [workflow]. For [resource/version], please confirm the prerequisites, editable files and supported integration path. What evidence covers this setup, and what remains untested?

Include no licence keys, account identifiers or customer data. Use a manifest generator/validator to inspect a declaration, then compare it with the actual files and installation instructions. Complete the worksheet before choosing a resource.

Technical documentation checked: 9 October 2026. No package runtime results were collected for this worksheet.