Getting started

This guide will help you get started with Lith Studios scripts on your FiveM server.

Prerequisites

Before installing any Lith Studios scripts, ensure you have:

• FiveM Server - A working FiveM server (latest stable version)

• Framework - ESX or QBCore or QBox installed (for most scripts)

• Database - database server running

• Basic Knowledge - Understanding of FiveM server structure and Lua scripting

Installation Process

General Installation Steps

1

Download the Script

• Obtain the script from Lith Studios

• Extract the archive to a temporary location

2

(Optional) Create a [lith] folder

Create a folder name [lith] for easy storage to all our scripts

3

Place in Resources Folder

/resources/[lith]/script_name/

4

Install and configure kq_link (if applicable)

Newer scripts use kq_link. Wheter you need to install kq_link is in our package description on our website. To configure kq_link:

• Open config.lua or similar configuration files

• Set your framework (ESX or QBCore)

• Adjust settings to match your server need

5

Database Setup (if required)

• Import any .sql files provided

• Configure SQL driver in config (if script doesn't use kq_link)

• Test database connection

6

Add to server.cfg

ensure script_name

7

Start/Restart Server

• Start your server or use refresh and ensure script_name

Script-Specific Requirements

Some scripts have special requirements:

ls_wheelspacers need ls_bolt_minigame to function

Scripts using kq_link

• ls_locker_theft

• ls_pickpocketing

• ls_snatch

• ls_handbrake

• ls_props

• ls_wheelspacers

• ls_image_placer

• ls_brake_cutting

Testing

1

Test in Development

• Set up a test server with your configuration

• Test all features thoroughly

• Check for console errors

2

Performance Check

• Monitor server performance (ms)

• Check for any lag or stuttering

• Optimize render distances if needed

3

Player Testing

• Have players test the script

• Gather feedback on gameplay

• Make adjustments as needed

Common Issues

Script Not Starting

• Check server.cfg has ensure script_name

• Verify all dependencies are installed

• Check console for error messages

• Ensure proper folder structure

Database Errors

• Verify SQL driver is correct in config

• Check database credentials

• Ensure tables are created

• Test database connection

Framework Issues

• Confirm framework is running

• Check framework version compatibility

• Verify framework export settings