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.
#Good To Know
#Keys
Our resource boasts a built-in premium keysystem with backwards compatibility for the most popular alternatives on the market (qs, wasabi, qb). In order for our system to work properly, you are required to disable any other keysystem on your server.
If you keep our keysystems on your server, including the ones we have listed as backwards compatible, you WILL face synchronization issues.
#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 in the garage builder and your default garage to avoid having to transfer your vehicles later down the line.
#Basic Setup
To get started, you will need to have completed at least these listed steps. It is very much recommended to read the rest of the page to ensure the resource runs smooth on your server.
All of our databases queries are automatically executed the first time you run the script, along with repairs if needed when you start it in the future.
#Dependencies
First, make sure to download all dependencies. It is also important that you follow a proper starting sequence, you can use our guide (Resource Starting Sequence) if you are uncertain.
- zyke_lib (Our central dependency / framework bridge)
- OxMySQL (You should already have this)
- PolyZone (You most likely already have this)
- zyke_realisticvehicles (Optional - Highly Recommended)
- zyke_sounds (Optional - Highly Recommended)
#Sounds (Optional)
If you want to use our sound system, you must download zyke_sounds. It is a separate resource that powers our other resources already, it is not built into garages.
If you are on the latest update of
zyke_sounds, the base sounds are already added, if not, extract the sounds fromzyke_garages/extras/soundsand put intozyke_sounds/nui/sounds.
#Items
Go into
zyke_garages/extras/itemsand add the items for your inventory. You can find images inzyke_garages/extras/items/images.
#Vehicle Migration (Optional)
There's a few steps to this, but they're all recommended. Note that you only need to migrate existing owned vehicles. If you have a fresh server, you can skip this step.
First, you should run this command to initialize the default vehicles. This will insert the needed data into all base GTA vehicles that we recorded, which is ~800. This is instant.
Next up are your custom vehicles. We can't pre-seed this data for you, so a one-time migration is needed. You run this command, and it will go through your vehicle list, spawn in the vehicle, grab the vehicles and insert it into your database. You can see a demo video here: Initialization Showcase (500 Random Vehicles, 18.2s) - Slightly outdated, now even faster! Does depend on your system performance, though.
For those that are technical, we fetch & store certain values that are not available on the server-side instead of having to fetch them in real time or every time the server starts. This is a one time thing for migrations if you previously had vehicles.
#Good To Know
We strongly recommend you read the rest of this page to avoid any issues.