Installation basics

Installing one of our resources? On this page you will learn how to successfully install a FiveM script

Step 1 - Downloading the resource

First off you will need to download the resource. Navigate to your keymaster and head to the "Granted assets" page.

There you should be able to find the assets you've purchased

Step 2 - Adding resource to the server

Unzip the file, then drag the file to your servers resources directory

Step 3 - Ensuring the resource

After you've put the resource folder into your server, open server.cfg file which should be located in the root directory of your server.

Add ensure resource_name to the bottom of the server.cfg file.

Dependencies

Read the script specific installation guide or the product page to find out if the script uses any dependencies. If it does, make sure that the script is started after all the dependencies

Step 4 - SQL

Read the script specific documentation to see if any sql files need to be imported into your servers database. You can find out more on the Frequently asked questions page

Step 5 - Adding items

Many of our scripts add new items, so make sure to add them to your server.

ESX

To add new items to your ESX server. You will need to import the sql file (should already be done in the previous step)

You may also need to add the items to your inventory systems configuration/item list.

QBCore / QBox

To add new items to your QB- framework, you will need to add them to the items.lua file or shared.lua depending on the framework version. Read the script specific installation guide to learn more

You may also need to add the items to your inventory systems configuration/item list.

Step 6 - Framework configuration

In most of our resources, you will need to set the framework in the config.lua file. If you're using ESX, simply enable the esx in the config file. Make sure to disable QBCore. If you're using QBCore make sure to disable esx and enable QBCore.

If you're using QBox, you should be able to use our QBCore implementation, so simply enable the QBCore option You may also need to set "UseNewExport" options under the framework options, as long as your frameworks are decently new, this will most likely will have to be set to true

Step 7 - Test the script

Before further modifications to the config file, we advise to test the script with the default configuration to make sure that everything is wroking correctly