FiveM: Installing Resources – in One Click or via SFTP

You can use resources to expand your FiveM game server with additional features. This is especially exciting if you are planning larger projects like a roleplay server or similar. Such projects are hardly possible without these additional resources.

FiveM and its community offer a huge selection of resources. An overview of the most popular resources can be found in the Cfx.re forum: https://forum.cfx.re/c/development/releases/7

The fastest way to install a resource is the FiveM Resource Installer right in your dashboard. You upload the ZIP archive, and the installer places the resource in the right folder, adds it to your server.cfg and, if you want, imports the included SQL files into your database. The classic way via SFTP is described further below.

ScreenshotInstall FiveM resources in one click with the Resource Installer in your dashboard: upload a ZIP, add the ensure line automatically, import the SQL file directly. Or install manually via SFTP.

Open your FiveM server's dashboard, go to the Tools tab and select FiveM Resource Installer. You don't need to stop your server.

A server template (recipe) must already be set up in txAdmin. Only then is there a server.cfg and a resources folder the installer can write to.

Upload the resource as a ZIP archive. A GitHub download via Code → Download ZIP or a release ZIP works as is.

• ZIP files up to 100 MB are allowed (at most 400 MB and 5,000 files unpacked).
• Repackage RAR and 7z archives as ZIP files first.
• The installer removes unnecessary intermediate folders (e.g. my-resource-main) and strips version and -main suffixes from the name.
• If an archive contains several resources, the installer lists them separately and sorts them by their dependencies.
• Executable files such as .exe, .bat or .sh are never written to your server.

Before anything is installed, the installer shows you what's in the archive:

• Name and target folder: The name may contain letters, digits and _, . and - (64 characters max). Under Folder in resources/ you pick the category folder, for example [standalone]. If the archive doesn't bring one, [local] is preselected. Directly in resources/ (no folder) places the resource without a category folder.
• Dependencies: For each dependency (e.g. ESX, QBCore, Qbox, ox_lib, oxmysql) you see whether it is in the archive, on the server or missing from the server. Dependencies that only show up in the code and aren't listed in fxmanifest.lua are marked as suspected.
• Security scan: The installer checks all .lua and .js files for known malicious code patterns. If it finds one, you get a warning. You can still install the resource, but the security scan disables it at the next server start. If you think it's a false positive, contact our support.
• SQL files: Included .sql files are listed, together with which tables they create, modify or write data to.

If the resource already exists on your server, the installer stops by default. To replace it (e.g. for an update), tick Overwrite existing resource. This replaces the entire folder, including your settings such as config.lua. The old folder is saved as an archive under backups/resource-installer/ first.

Leave Add to server.cfg so it starts automatically ticked. The installer then adds ensure <name> after the resource's dependencies in the server.cfg of your active server folder and saves the old server.cfg as server.cfg.bak-… first.

Click Install on server. You'll see the progress (backup, extracting, putting in place, updating server.cfg, checking the result). The installation keeps running if you close the page.

The result tells you how the resource starts:

• ensure line added to server.cfg: all done.
• already in server.cfg: the line was already there.
• starts via the category folder: your server.cfg already contains ensure [category], which starts the resource as well.
• ensure line still missing: add ensure <name> to your server.cfg yourself (see Activation).

For FiveM to load the new resource, restart your server with Restart server. Alternatively, enter refresh and then ensure <name> in the live console.

If the resource needs a database, you import its SQL file right from the installer. This does not happen automatically, only when you click Import into database for the file.

1. Select your server's database. The primary database is preselected. If your server doesn't have a database yet, create one via Create database in the Databases tab.
2. If tables from the file already exist, the dialog tells you. Keep Skip existing tables (recommended) selected. This keeps existing tables and their data untouched.
3. With an active ZapX Pass, a backup of the database is created automatically before the import. Without a Pass, you confirm that you're importing without a backup.
4. Click Import now.

Each file can have up to 2 MB and 5,000 SQL statements. Import larger files via phpMyAdmin as described in FiveM: Importing an SQL File.