FiveM resources, scripts and frameworks

FiveM mods are called resources: folders of scripts, cars, maps, clothes or menus that live in your server’s resources folder and start with an ensure line in server.cfg. Players don’t install anything: FiveM downloads each server’s resources for them when they join.

How resources work

• Each resource is a folder with an fxmanifest.lua file at its top level. That file tells FiveM what the resource contains.
• Folders with brackets around their name, like [cars] or [qb], are categories. They group resources and aren’t resources themselves.
• A resource only runs if server.cfg starts it with ensure name. You can also start a whole category with ensure [cars].
• Many resources need others to work, called dependencies. A script made for QBCore needs QBCore. Read each resource’s page before you install it.

Frameworks

Roleplay servers are built on a framework: a base that handles characters, jobs, money and inventories, which other scripts build on. Most scripts are made for one framework, so pick yours first.

Each one needs a database (MariaDB) for player data. Cfx.re lists frameworks on its docs, but doesn’t make or support them. Help comes from each framework’s own docs and community.

Install a framework or starter from Mods

The Mods tab offers txAdmin recipes, which build a whole server in one go:

1. Open Mods and choose a recipe: a plain server, QBCore, ESX Legacy or Qbox.
2. Read the summary and confirm.
3. A backup is made first. The recipe then downloads its resources, writes server.cfg and sets up the database.
4. Restart when it asks.

A recipe replaces your current setup. To try one without losing your server, duplicate the save in Games first.

Install a resource by hand

Most scripts are installed by hand. You can upload through Files or with SFTP (works with FileZilla).

1. Download the resource from its maker, and unzip it on your computer.

2. Check the folder. The fxmanifest.lua file must be at the top of the folder, not one folder deeper. GitHub downloads often add -main to the folder name, so rename it to the resource’s real name, like my-garage.

3. Upload the folder into resources. A category such as resources/[local] keeps your own additions tidy.

4. If the resource came with a .sql file, it needs tables in your database. Follow its install guide.

5. Open server.cfg and add a line under your framework’s lines:

   ensure my-garage

6. Start it without a full restart: type refresh in the Console, then ensure my-garage. Or restart the server.

Check the Console for red errors right after it starts. Most problems are a missing dependency or the wrong framework.

Cars, maps and clothes

Custom cars, maps (often called MLOs) and clothes are resources too, with their files in a stream folder. Some notes:

• Big streamed files make players’ first join slower, because each player downloads them. Keep an eye on the total size.
• Newer game content may need a higher sv_enforceGameBuild in server.cfg. See game builds.
• FiveM for GTA V Enhanced loads assets from a stream_enhanced folder when a resource has one. Older resources may need converting for Enhanced.

Paid and escrowed resources

Some paid scripts are escrowed: locked so their code can’t be read or changed. They come with a .fxap file and only run on servers whose license key belongs to the Cfx.re account that bought them.

• Buy paid resources only through the Cfx.re Marketplace or Tebex. Rockstar’s rules don’t allow other stores to resell other people’s scripts.
• Upload the whole folder, hidden files included. In FileZilla, turn on Force showing hidden files in the Server menu before you upload. If the .fxap file is missing, the server says it failed to verify a protected resource.
• If you bought it on another account, transfer it to the account that owns the key on the Cfx.re Portal.

Never install “leaked” paid scripts. They break the rules and often contain hidden code that harms your server. Cfx.re calls this “prohibited logic”.

Updates and versions

• Resources never update on their own, because updates can break a working server. A backup is made before every change you make in Mods.
• Update your framework and its scripts together. A new framework version can break older scripts made for it.
• Keep your server files (artifacts) recent too. Old artifacts can fail to load new scripts, and artifacts more than three months out of date can’t be joined from the server list.

What friends need

Nothing extra. When a friend joins, FiveM downloads every resource your server streams, including cars, maps and clothes. The first join takes longest. If a friend’s download keeps failing, see Couldn’t load resource.