Documentation › Quick Setup Guide

Quick Setup Guide

Install any Smile Scripts resource in a few minutes.

Every script has its own installation page with the exact items and settings. This guide covers the steps that are the same for all of them.

Before you start

  • A working FiveM server with up-to-date server artifacts
  • Access to the server files (FTP, txAdmin or a host panel) and to its database
  • oxmysql and ox_lib installed and started - every Smile Scripts resource needs them

Install a script

Download it from the Cfx Portal

Log in to portal.cfx.re with the same Cfx.re account you used at checkout and open Granted Assets. Find the script and download the archive.

Put it into your resources

Extract the archive into your server's resources folder. We recommend keeping the original folder name.

When you upload over FTP, use binary transfer mode. Text mode damages the protected files and the server reports Syntax error near <\1>.

Add it to server.cfg

Start dependencies first and the script last:

text
ensure oxmysql
ensure ox_lib
ensure your_framework     # es_extended / qb-core / qbx_core
ensure your_inventory
ensure your_target        # optional
ensure smilescripts_hunting

Add the items

Open the install/ folder of the script. It contains the item definitions for each supported inventory and the item icons. Add the items and copy the icons into your inventory's image folder.

For the Hunting System, the install generator on the product page prints the exact lines for your inventory.

Restart and check the console

Restart the server. Database tables are created automatically on the first start. Read the console: errors are reported there, and most scripts print what they detected.

Next steps

Read the script's own installation page - some scripts need an extra step, such as an API key or a config value.

Something does not work? Check Common Issues or open a ticket on Discord.