Login with CFX
How to install a FiveM script - KuzQuality | FiveM Scripts

How to install a FiveM script

Installation

Installing a FiveM script is not complicated. But if you have never done it before, it helps to understand how the server loads scripts before jumping in.

What Is a FiveM Script?

FiveM scripts are called resources. A resource is a folder that contains everything a script needs to run. That includes client files, server files, config files, and any UI assets.

Every resource folder needs a file called fxmanifest.lua. This file tells the server what to load. Without it, the server ignores the folder completely.

Step 1: Download and Extract the Script

Scripts are usually distributed as a .zip or .rar file. Extract it with 7-Zip or WinRAR.

Inside you will find the resource folder. It should contain at minimum:

  • fxmanifest.lua
  • One or more script files (client.lua, server.lua, config.lua, etc.)

Do not rename the folder contents unless the documentation says it is safe to do so. File paths inside fxmanifest.lua are case-sensitive and must match the actual file names exactly.

Step 2: Upload the Resource to Your Server

Resources go inside the resources/ folder in your server data directory. A typical structure looks like this:

server-data/
└── resources/
    └── [scripts]/
        └── your-script/
            ├── fxmanifest.lua
            ├── client.lua
            └── server.lua

Folders in square brackets like [scripts] are just categories for organization. They are not resources themselves. Scripts inside them still work fine.

Upload the resource folder via FTP, SFTP, or your hosting panel's file manager.

Step 3: Configure the Script

Most scripts include a config.lua file. Open it and set the values to match your server. This usually includes things like framework type, job names, and item names.

Read the documentation before starting the script. Skipping this step is the most common reason a script does not work after installation.

Step 4: Add the Script to server.cfg

Open server.cfg and add this line:

ensure your-script

Replace your-script with the exact name of the resource folder. Capitalization matters.

If the script depends on other resources like ESX, QBCore, or ox_lib, make sure those are listed higher up in server.cfg so they load first.

ensure is the current standard. It starts the resource and restarts it automatically if it crashes. The older start directive still works but ensure is preferred.

Step 5: Start the Resource

You do not need to restart the whole server. There are two ways to start a resource:

  • txAdmin: Go to the Resources panel, find the script, and click Start.
  • Server console: Type start your-script directly into the console.

Check the console output for errors. If the script loaded correctly you will see:

Started resource your-script

Common Issues

IssueLikely Cause
Resource not foundFolder name in server.cfg does not match the actual folder name
Missing fxmanifest.lua warningFile is missing or placed in the wrong directory
Script starts but does not workConfig not set up correctly, or a dependency is missing
Framework errors on startScript was built for a different framework than your server runs

Summary

  1. Extract the archive and find the resource folder.
  2. Upload it to server-data/resources/.
  3. Edit config.lua to match your server setup.
  4. Add ensure your-script to server.cfg.
  5. Start the resource and check the console for errors.

The process is the same for every script. The only part that changes is the configuration.