Prerequisites
Before you begin, confirm that your server meets the following requirements:- A running FiveM or RedM server with
server.cfgaccess. - oxmysql installed and started — required by any script that persists data (XP, vehicle keys, MDT records, housing, etc.).
- All script-specific dependencies listed in the resource’s
fxmanifest.luaare already installed and running. Check the individual script page if you are unsure what those are.
Installation Steps
Download the resource
Purchase and download the script from Tebex or the provided GitHub release page. You will receive a
.zip archive containing the resource folder.Extract into your resources directory
Unzip the archive and place the resource folder inside your server’s
resources/ directory (or any subdirectory within it, such as resources/[sh-scripts]/).Add ensure to server.cfg
Open your
server.cfg and add an ensure line for the script. Place it after any dependencies it requires.server.cfg
Import the SQL file
If the resource includes a Scripts that do not use a database will not include a
.sql file (usually found in the INSTALL/ folder or the root of the resource), import it into your database before starting the script for the first time.You can do this with any MySQL client (HeidiSQL, DBeaver, phpMyAdmin) or via the command line:.sql file — this step is optional in that case.Configure config.lua
Open Every available option is documented with inline comments. See the Configuration guide for a full walkthrough.
config.lua in the resource folder and adjust the settings for your server. At minimum, set the correct framework and notification system:config.lua
Verifying the Installation
After starting the resource, confirm it is running correctly:- Run
statusorresmonin the server console and look forsh-scriptnamein the resource list. - Trigger the script’s main feature in-game (open a menu, run a command, or enter a configured zone) to verify it responds as expected.
- If you see errors, check the console for missing dependency messages and confirm all
ensurelines are in the correct order.