🚧Setup

Various steps to ensure our script works on your server.

In-depth Guide

You just downloaded our resources and wondering where to get started? This is for you. We will instruct you on how to get it set up for all different types of servers.

Dependencies

Make sure to include all the script's dependencies on your server. You can find these here.

Database

For this particular resource, there are multiple sql queries that needs to be ran, some with more than one version, so let's break them down. All of these can be found in the extras folder.

Required

Run both of the SQL queries.

• zyke_default_garages.sql

• zyke_cleanup_settings.sql

Framework Specific

Choose the SQL query specific to your framework

• QB -> QBCore Modifications.sql

• ESX -> ESX Modifications.sql

Note that we also offer a fresh SQL to run if you don't have an existing table, however, this is very rare and won't be covered in here to avoid any confusion.

Garages

If you want ~20 pre-configured garages to get started without any extra setup, you can run our SQL query and get started right away. If you would like to create and customize all garages yourself, run the clean one.

• Pre-configured Garages (~20) -> zyke_garages WITH BASIC GARAGES.sql

• Empty garage list -> zyke_garages CLEAN.sql

Manual Cardealer Setup - DEPRECATED

Since the 1.2 release, a manual setup is not needed, as it is now automatic. However, if it is required, the instructions can be found in the expandable below.

If you have the experience and capabilities to install our exports, we always recommend doing that. Running an automated system in the background creates a slight delay (0.5-2s) and overhead. We always take every step possible to ensure the best performance possible, but if you want to shave the slight delay and overhead off, it is entirely possible.

Manual Cardealer Setup

Cardealer

Automatic Setup Existing

• Zerio's Cardealer

• Missing your cardealer? Create a ticket here and let us know, we wish to expand this section!

Semi-Automatic Setup Existing

These are dealerships we have pre-configured snippets for to easily paste in. Create a ticket and we will assist you swiftly.

• MT Dealership V2

• ESX & QBCore's Default Vehicleshop - Please note that your version may cause incompatabilies with our pre-configured solutions. Fear not, we will help you get it all sorted either way!

Manual Setup Needed

esx_vehicleshop

• Navigate here.

• Jump down one row, so that you are right below where the link leads to.

• Paste in the following code:

TriggerClientEvent("zyke_garages:HandleVehiclePurchase", source, vehicle, plate)

qb-vehicleshop

• Navigate here.

• Jump down one row, so that you are right below where the link leads to.

• Paste in the following code:

TriggerEvent("zyke_garages:HandleVehiclePurchase", netId, QBCore.Functions.GetPlate(veh))

Vehicle Migration / Initialization

Initialization Showcase (500 Random Vehicles, 18.2s)

Our garage contains a lot of functionality, and because of this, there has to be a vehicle migration performed. Don't worry, it's easy!

All you have to do is run the command found here. However, we very much recommend you read the information below and watch the showcase to be prepared as to what will happen.

All previous vehicle details will stay exactly as before. This step is required since some values we use are impossible to fetch without having the entity be spawned.

Good To Know

Clear Old Appended Columns

To ensure that the command completely works, we recommend you deleting any columns that was created by a previous script, that is not native to your cardealer for your framework. This is not always required, but can cause issues if a previous garage system has had similar column names and set value types not corresponding to what we require. If you want help, we offer free support for this through our Discord.

Specifically, some servers may already contain a vin column, which will incorrectly flag the vehicle as already initialized.

Perform Database Backup

We recommend performing a database backup. The resource has been tested numerous times and works, but you should always create a backup just in case.

Default Garage

If you are initializing vehicles without any garages set up, the default garage will become a random one, or none at all since one could not be found. Make sure to set up your garages and your default garage to avoid having to transfer your vehicles later down the line.