Install a FiveM resource

Back up your serverCopy Anchor Link

Copy server.cfg, the resource folders you will change and any shared item/job definitions; export your database. Store the backup outside resources. Try the installation on a separate test server and database before changing a server with players.

Unpack the zip and find the resource folderCopy Anchor Link

A resource folder is the folder that contains fxmanifest.lua directly. Some downloads wrap it in an extra folder, or contain several resources (for example a script and its props). Open the zip and look for every fxmanifest.lua: each folder that holds one is a resource.

Files you do not install: readme files, preview images and .sql files. You import the SQL in step 4.

Copy the folder to resourcesCopy Anchor Link

Move each resource folder into your server's resources directory. Folders with brackets, such as resources/[scripts]/, are only for grouping; the server finds resources inside them.

Keep the folder name the product documentation uses. Other resources often call a script by its folder name (exports['resource_name']), so a renamed folder can break them.

Import the SQL file, if there is oneCopy Anchor Link

Many scripts ship a .sql file that creates their tables or adds items. Use the file intended for your framework and a fresh installation, read it first, then import it into your test server database with HeidiSQL, phpMyAdmin or your host's panel. Existing installations need the creator's update instructions. Database precautions.

Install the dependencies and add itemsCopy Anchor Link

The product page and the readme list what the resource needs, often ox_lib, oxmysql or a target and inventory resource. Install those first.

Scripts that use inventory items need them registered in your framework. Where that happens depends on the framework: QBCore, ESX, Qbox.

Configure itCopy Anchor Link

Open config.lua (or the config folder) and set the framework, inventory, target and notification options to what your server uses. Many errors after a successful start come from a config that still points at a resource you do not run.

Start it from server.cfgCopy Anchor Link

Add the resource after its dependencies. For a QBCore script that explicitly requires oxmysql and ox_lib, an example is:

ensure oxmysql
ensure ox_lib
ensure qb-core

ensure resource_name

Use your framework's start order and the resource readme. A standalone map does not need qb-core, ox_lib or a database unless its own instructions say so.

Restart the server. A full restart is safer than restart resource_name for new resources, because items, jobs and SQL changes are often only read at startup.

Check the consoleCopy Anchor Link

Watch the server console (or txAdmin's live console) while the server starts. A clean start prints Started resource resource_name and no related errors. Then connect with a test player, inspect F8 for client errors, and exercise the feature: use an item, open its UI, enter the MLO or spawn the vehicle, as applicable. Reconnect and restart the server to check that saved data persists.

If it does not start, go to Startup errors.