Basic configuration

1

The database is set up automatically; if you have any problems, open ticket in discord.

2

Configure your language

If your language isn't listed here, you can add it or even open a ticket and we'll add it for you!

--[[  
Configure your language using the following:
    'es' -> Spanish
    'en' -> English
    'fr' -> French
    'de' -> German
    'it' -> Italian
    'pt' -> Portuguese
]]
Config.Locale = 'en' 

3

Add this to exclude vehicles according to your framework

ESX

Go to the next route es_extended/server/modules/commands.lua and find the following command to replace this one:

ESX.RegisterCommand(
    "car",
    "admin",
    function(xPlayer, args, showError)
        if not xPlayer then
            return showError("[^1ERROR^7] The xPlayer value is nil")
        end

        local playerPed = GetPlayerPed(xPlayer.source)
        local playerCoords = GetEntityCoords(playerPed)
        local playerHeading = GetEntityHeading(playerPed)
        local playerVehicle = GetVehiclePedIsIn(playerPed, false)

        if not args.car or type(args.car) ~= "string" then
            args.car = "adder"
        end

        if playerVehicle then
            DeleteEntity(playerVehicle)
        end

        if Config.AdminLogging then
            ESX.DiscordLogFields("UserActions", "Spawn Car /car Triggered!", "pink", {
                { name = "Player", value = xPlayer and xPlayer.name or "Server Console", inline = true },
                { name = "ID", value = xPlayer and xPlayer.source or "Unknown ID", inline = true },
                { name = "Vehicle", value = args.car, inline = true },
            })
        end

        local xRoutingBucket = GetPlayerRoutingBucket(xPlayer.source)

        ESX.OneSync.SpawnVehicle(args.car, playerCoords, playerHeading, upgrades, function(networkId)
            if networkId then
                local vehicle = NetworkGetEntityFromNetworkId(networkId)

                if xRoutingBucket ~= 0 then
                    SetEntityRoutingBucket(vehicle, xRoutingBucket)
                end

                exports['jc_vehiclekeys']:ExcludeVehicle(xPlayer.source, vehicle)
                
                for _ = 1, 100 do
                    Wait(0)
                    SetPedIntoVehicle(playerPed, vehicle, -1)

                    if GetVehiclePedIsIn(playerPed, false) == vehicle then
                        break
                    end
                end

                if GetVehiclePedIsIn(playerPed, false) ~= vehicle then
                    showError("[^1ERROR^7] The player could not be seated in the vehicle")
                end
            end
        end)
    end,
    false,
    {
        help = TranslateCap("command_car"),
        validate = false,
        arguments = {
            { name = "car", validate = false, help = TranslateCap("command_car_car"), type = "string" },
        },
    }
)

QB-Core

QBox

4

Add the items according to your framework

Add the images to your inventory jc_jc_vehiclekeys/[Assets/img_inventory

ESX

INSERT INTO items (name, label, weight, rare, can_remove)
VALUES 
('lockpick', 'LockPick', 1, 0, 1),
('hacking', 'Hacking Device', 1, 0, 1);

QB-Core

5

Install the key exports in your vehicle shop or garage system if they are not directly compatible with the system

If the garage or vehicle shop uses qb-vehiclekey or qbx_vehiclekey and does not use our key system, you do not need to adapt this

Client Exports

How do I get the license plate if it's not predefined?

local plate = GetVehicleNumberPlateText(vehicle)

Add key to Player

exports['jc_vehiclekeys']:GiveKeys(plate)

Remove Key to Player

exports['jc_vehiclekeys']:RemoveKeys(plate)

If you don't know how to do it, you can open a ticket and we'll help you integrate it

Do you want to use the vehiclekey item?

insert the item according to your framework:

ESX:

INSERT INTO items (name, label, weight, rare, can_remove)
VALUES ('vehiclekey', 'Vehicle Key', 1, 0, 1);

QB-Core

['vehiclekey'] = {
    name = 'vehiclekey',
    label = 'Vehicle Key',
    weight = 100,
    type = 'item',
    image = 'vehiclekey.png',
    unique = true,
    useable = false,
    shouldClose = true,
    combinable = nil,
    description = 'Vehicle Key'
},

Insert the image into your inventory