Add a script or resource to your FiveM server
you add a script (a “resource”) to your FiveM server, declare it in `server.cfg` and check it loads.
Before you start
- A resource is a FiveM script folder: vehicles, jobs, interfaces, maps… Free or paid script sites distribute them as a folder or a
.ziparchive. - Check the resource is compatible with your framework (Qbox, QBCore, ESX…): a resource written for ESX does not work on Qbox without adaptation.
- Keep a backup of your
server.cfg: copy the file before editing, or useserver.cfg.bkpwhen it exists.
Find the right resources folder
With txAdmin, the server’s files are in txData/<recipe name>.base/: for example txData/Qbox_FC1A36.base/. That is where the real server.cfg and the resources folder are. The server.cfg and resources folder at the server root belong to a default template: do not edit them, they are not your game’s. Inside resources, the sub-folders in square brackets ([standalone], [qbx], [ox]…) are for tidying: the game scans them all.
Upload the resource
In the file manager or over SFTP, upload the resource folder into resources/[standalone] (the folder for independent resources). The folder must hold an fxmanifest.lua file at its root: without it, FiveM does not recognise it. If you get a .zip, unzip it first so fxmanifest.lua sits directly in the resource folder, not one sub-folder deeper.
Minimal example (our test): a wiki_demo folder holding fxmanifest.lua (fx_version 'cerulean', game 'gta5', server_script 'server.lua') and server.lua (a single print(...) line).
Declare the resource in server.cfg
Open server.cfg (the one from step 1) and add an ensure folder_name line, after the resources it depends on (for example after ensure qbx_core for a Qbox script):
ensure wiki_demo
The name is the resource folder‘s name. Save.
Restart and check
Restart the server from the panel. Wait two to three minutes. To check the resource is loaded, open http://IP:port/info.json: the resources list contains your resource’s name. We tested it: the list went from 82 to 83 resources with wiki_demo. You can also read the txAdmin console, which prints “Started resource …”.
Live commands
txAdmin offers a live console where the refresh (re-read folders) then ensure name commands load a resource with no restart. Careful: we typed these commands in the panel console, and they had no effect (the resource did not load): for FiveM, use the txAdmin console, or restart.
If it does not work
The resource does not load
fxmanifest.lua is missing or misplaced (one sub-folder too many), or the name in ensure does not match the folder name.
A “could not find dependency” error
another resource must load first. Place your ensure after it.
The server crashes at startup after an addition
remove the ensure line you added (or put server.cfg.bkp back) and restart.
The restart stays stuck on “Arrêt en cours” (stopping)
wait two minutes; otherwise use the Kill button then Start (see the panel defect report).
The script does not work in game
read the txAdmin console and the in-game F8 log; check the framework and the script’s own configuration (usually a config.lua file).
Questions? Get in touch
Our team will answer by message or on Discord.