GUIDE

Installing a FiveM script

The steps below are the same for every script we sell. Each product page repeats the ones specific to it, so read this once and the rest is quick.

Installing a FiveM script

Where the files come from

Purchases are delivered by Tebex and land in your Cfx.re Keymaster account, under Granted assets. Download from there, not from a link someone sends you. A script that reaches you outside that channel has no entitlement attached to your licence key, which means no updates and no recourse.

Dropping the resource in

Copy the folder into your resources directory, keeping the folder name exactly as delivered. The name is what exports calls use, so renaming it breaks every integration you or another resource might have. Then add the start line to your server config.

lua
ensure oxmysql
ensure avenida_barber

Why the order matters

Start the database layer before the script, because the script writes on boot. If your framework starts after us, the bridge retries and still finds it, but starting oxmysql late gives you an SQL error instead of a retry.

Running the SQL

Each script ships an INSTALL.sql split into labelled sections. Section [A] is required and always runs. The later sections are conditional, and the header of the file states exactly when you need them, typically appearance storage for servers that do not already have one.

Checking the install went through

Set Config.Debug = true, restart, and read the console. One line per bridge category names the target that was picked. Most scripts also expose a check command that prints a full install report in game, for example /avenida_barber_check, once you have granted yourself the ace.

lua
add_ace group.admin avenida_barber.admin allow

What to configure before opening the doors

Two things are worth deciding before players arrive: the locale, in Config.Locale, and the prices, which live in the config file named after the script. Everything else has a default that works on most servers.

Updating later

Download the new version from Keymaster and replace the folder, keeping your config/ and locales/ files. Those two directories are outside the escrow precisely so your edits survive an update, and the changelog names anything that moved.

Questions

Do I have to restart the whole server?

No, a resource restart is enough for config and locale changes. The SQL only needs to run once, and a full restart is only useful when you change the resource start order.

The script does not start, where do I look first?

The server console at startup. A missing dependency, a wrong folder name and a failed SQL all print a line there. Set Config.Debug = true and restart to get one line per bridge category, which tells you whether detection found what you expected.

Can I rename the resource folder?

No. The folder name is what exports calls use, both ours and yours, so renaming it silently breaks every integration. If you need a different name in your server config, use a symlink rather than a rename.

Where do I find my files again after a reinstall?

In your Cfx.re Keymaster account, under Granted assets. The entitlement follows the account that bought the script, so a fresh server or a new machine changes nothing.

Scripts that use this

Cart
Spirit RP
Discord