Installation

Welcome to the Vehicle Keys installation guide, here you can learn how to install our product completely, by following each step, we'll get a clean and smooth installation where you won't find any problems.

Please follow the information below step-by-step before opening a support request on Discord. If you encounter a problem despite the documentation, please open a ticket on the Discord server, giving as much detail as possible about your problem.

---

Download and installation

Once you've purchased the asset in the store, you can retrieve it from your portal.

Simply drag the folder ux_vehiclekeys contained in the .zip file into your server's resource folder, add the line below to your server.cfg file and restart your server !

If you have any problems with the Escrow System, please read this page and do what it says.

---

Configuration

You can edit the /configs/config.lua file to adapt the script as you wish.

Start by modifying the framework on which your server runs, usually ESX or QBCore. The line to edit is the one below:

UXConfig.Framework = "esx" --[[
	"qb": QBCore
	"esx": ESX Legacy
    "custom": Custom Framework, need to change /client/frameworks.lua and /server/frameworks.lua
]]

---

Use Keys in Items

Item keys allow for more immersive gameplay, as you interact with the keys via the inventory.

By activating this option in the script, the tablet is automatically deactivated, and everything is done directly in the inventory. To retrieve the keys of an item vehicle, go to the client or server exports.

In /configs/config.lua, set the line to true:

UXConfig.UseItemKeys = true

---

Create the vehiclekey item in your inventory, so that it can be used.

Example for qs-inventory in qs-inventory/shared/items:

['vehiclekey'] = {
    ['name'] = 'vehiclekey',
    ['label'] = 'Vehicle key',
    ['weight'] = 3,
    ['type'] = 'item',
    ['image'] = 'vehiclekey.png',
    ['unique'] = true,
    ['useable'] = true,
    ['shouldClose'] = true,
    ['description'] = 'Vehicle key to lock or unlock the vehicle.'
}

Example for ox_inventory in ox_inventory/data/items:

['vehiclekey'] = {
    label = 'Vehicle key',
    weight = 3,
    stack = false,
    close = true,
    server = {
        export = 'ux_vehiclekeys.vehiclekey'
    },
}

Lockpick

Configuring the lock-picking system.

In /configs/config.lua, set the line to true:

UXConfig.Lockpicking = true

---

Create the lockpick item in your inventory, so that it can be used.

Example for qs-inventory in qs-inventory/shared/items:

['lockpick'] = {
    ['name'] = 'lockpick',
    ['label'] = 'Lockpick',
    ['weight'] = 160,
    ['type'] = 'item',
    ['image'] = 'lockpick.png',
    ['useable'] = true,
    ['shouldClose'] = true,
    ['description'] = 'Lockpick for lock-picking vehicles.'
}

Example for ox_inventory in ox_inventory/data/items:

['lockpick'] = {
    label = 'Lockpick',
    weight = 160,
    close = true,
    server = {
        export = 'ux_vehiclekeys.lockpick'
    },
}

---

If you use a custom framework, little support from us is guaranteed. The files you need to modify to make the script work properly on a custom framework are available, but you are solely responsible for these modifications.

For a custom framework (other than ESX and QBCore) you'll need to edit client-side functions in /client/frameworks.lua and server-side functions in /client/frameworks.lua. The functions are commented out in the relevant files.