Install scripts

A step-by-step guide for installing FiveM scripts on your server.


Before You Start

Always check the script's documentation for:

  • ✅ Required framework (ESX, QBCore, or standalone)

  • ✅ Any dependencies that must be installed first

  • ✅ Whether a database (SQL) setup is needed

  • ✅ The correct resource name to use in server.cfg

1

Step 1 — Download the Script

  • Download the .zip file from our storearrow-up-right or the provided link

  • If you purchased it, check your email or account page for the download

2

Step 2 — Extract the Files

  1. Right-click the .zipExtract All

  2. Check the extracted folder name — it should match the resource name in the docs

  3. Rename it if needed (no spaces in the folder name)

circle-exclamation
3

Step 3 — Upload to Your Server

Place the extracted folder inside your server's resources/ directory.

Example structure:

Example
FXServer/
└── resources/
    └── [cjm]/
        └── cjm-scriptname/
            ├── fxmanifest.lua
            ├── client/
            └── server/
circle-info

We recommend organising your resources in subfolders like [cjm], [esx], [custom] — this keeps things tidy and doesn't affect functionality.

4

Step 4 — Import the Database (if required)

Some scripts need database tables to store data.

  1. Open your database manager (e.g. HeidiSQL, phpMyAdmin, or DBeaver)

  2. Connect to your server's database

  3. Open the .sql file included with the script

  4. Run / execute the SQL

  5. Confirm the new tables appear in your database

5

Step 5 — Configure the Script

  1. Open the config.lua (or config.js / config.json) file in the resource folder

  2. Read through each option and adjust to fit your server

  3. Save the file

Common config settings you may need to change:

Setting
What to set

Framework

'esx' or 'qb-core' depending on your server

Discord Webhook

Paste a webhook URL from your Discord server

Permissions / Job

Set which job or role can access features

Database name

Usually auto-detected, but check if errors occur

6

Step 6 — Add to server.cfg

Open your server.cfg and add:

server.cfg
ensure cjm-scriptname

Make sure this line comes after any dependencies the script requires.

7

Step 7 — Restart Your Server

  1. Save all files

  2. Restart your FiveM server (or use restart cjm-scriptname in the txAdmin console if it was already running)

  3. Check the server console for any errors on startup


Troubleshooting Install Issues

Problem
Fix

resource not found

Check the folder name matches exactly what's in server.cfg

fxmanifest.lua not found

You've added the wrong (outer) folder — go one level deeper

SQL errors on startup

Make sure you ran the .sql file in your database

Script loads but doesn't work

Check your config.lua — wrong framework or missing dependency

Dependency error

Install the listed dependency first and ensure it before this script

circle-info

Still stuck? Open a support ticket in our Discordarrow-up-right and share your server console error — we'll sort it out.