> For the complete documentation index, see [llms.txt](https://m4ster.gitbook.io/uniquedevelopment/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://m4ster.gitbook.io/uniquedevelopment/resources/esx/rental-car-system/config.md).

# Config

```lua
lib.locale()

Config = {}

Config.Framework = 'esx' -- 'esx' or 'qbox'

Config.ReturnPercentage = 20 -- Percentage of refund when returning the vehicle

Config.CheckVersion = true -- Enable or disable version check

Config.Webhooks = {
    enabled = true, -- Enable or disable discord logs
}

Config.RentalPaperItem = 'rental_papers' -- Name of the rental papers item in ox inventory system

Config.UseKeySystem = true -- (okokGarage, qbx_vehiclekeys) Edit cl_function.lua and sv_function.lua if you want to use another key system
Config.KeyItemName = 'keys' -- Name of the key item in ox inventory system

Config.PaymentMethod = 'choice' -- 'cash' = Pay cash, 'bank' = Pay from bank, 'choice' = Player chooses
Config.RefundMethod = 'bank' -- 'cash' = refund in cash, 'bank' = refund to bank

Config.SpawnMode = 'inside' -- 'inside' = always in vehicle, 'outside' = always out of vehicle

Config.Categories = { -- Define vehicle categories here
    {
        label = 'Car',
        category = 'car'
    },
    {
        label = 'Bike',
        category = 'bike'
    },
    {
        label = 'Truck',
        category = 'truck'
    }
}

Config.Target = true -- Set to false to disable ox_target integration if false use 3dtext
Config.TargetIcon = { -- Define ox_target icons here
    rentIcon = 'fa-solid fa-car',
    returnIcon = 'fa-solid fa-right-to-bracket'
}

Config.Locations = { -- Define rental locations here
    {
        coords = vec3(-295.3566, -993.0552, 30.1823), -- Coords of prop/ped
        heading = 250.0, -- Heading of prop/ped
        modelType = 'prop', -- 'prop' or 'ped'
        model = 'uniquedevelopment_rent_prop', -- Prop or ped model
        vehicleSpawns = {
            vec4(-301.0811, -988.9852, 31.0806, 341.6912),
            vec4(-304.8909, -987.8618, 31.0806, 335.3633),
            vec4(-308.2188, -986.2409, 31.0806, 341.2238)   -- Vehicle spawn coords and heading
        },
        returnZone = vec3(-301.0811, -988.9852, 31.0806), -- Center of return zone
        returnRadius = 5.0, -- Radius of return zone
        debug = false, -- Enable or disable debug for return zone
        blip = {
            enabled = true, -- Enable or disable blip
            sprite = 225, -- Blip sprite (https://docs.fivem.net/docs/game-references/blips/)
            color = 3, -- Blip color (https://docs.fivem.net/docs/game-references/blips/#blip-colors)
            scale = 0.8, -- Blip scale (0.0 - 1.0)
            label = 'Rent-a-Car' -- Blip label
        },
        vehicles = {
            { label = 'Adder', model = 'adder', category = 'car', price = 100, image = 'vehicle.png' }, -- Vehicle list for this location
            { label = 'Banshee', model = 'banshee', category = 'car', price = 80, image = 'vehicle.png' },
            { label = 'Faggio', model = 'faggio', category = 'bike', price = 20, image = 'vehicle.png' },
        },
    },     
    {
        coords = vec3(-282.3466, -886.0345, 31.0806), -- Coords of prop/ped
        heading = 134.1221, -- Heading of prop/ped
        modelType = 'ped', -- 'prop' or 'ped'
        model = 'ig_abigail', -- Prop or ped model
        vehicleSpawns = {
            vec4(-285.9221, -887.9514, 31.0806, 170.6843), -- Vehicle spawn coords and heading
        },
        returnZone = vec3(-289.6004, -887.0095, 31.0806), -- Center of return zone
        returnRadius = 5.0, -- Radius of return zone
        debug = false, -- Enable or disable debug for return zone
        blip = {
            enabled = true, -- Enable or disable blip
            sprite = 225, -- Blip sprite (https://docs.fivem.net/docs/game-references/blips/)
            color = 3, -- Blip color (https://docs.fivem.net/docs/game-references/blips/#blip-colors)
            scale = 0.8, -- Blip scale (0.0 - 1.0)
            label = 'Rent-a-Car' -- Blip label
        },
        vehicles = {
            { label = 'Adder', model = 'adder', category = 'car', price = 100, image = 'vehicle.png' }, -- Vehicle list for this location
            { label = 'Banshee', model = 'banshee', category = 'car', price = 80, image = 'vehicle.png' },
        },
    },
    {
        coords = vec3(-346.0749, -872.6749, 30.0), -- Coords of prop/ped
        heading = 0.0, -- Heading of prop/ped
        modelType = 'prop', -- 'prop' or 'ped'
        model = 'prop_parkingpay', -- Prop or ped model
        vehicleSpawns = {
            vec4(-343.7057, -876.0108, 31.0714, 167.5911), -- Vehicle spawn coords and heading
        },
        returnZone = vec3(-340.0547, -876.5012, 31.0714), -- Center of return zone
        returnRadius = 3.0, -- Radius of return zone
        debug = false, -- Enable or disable debug for return zone
        blip = {
            enabled = false, -- Enable or disable blip
            sprite = 225, -- Blip sprite (https://docs.fivem.net/docs/game-references/blips/)
            color = 3, -- Blip color (https://docs.fivem.net/docs/game-references/blips/#blip-colors)
            scale = 0.8, -- Blip scale (0.0 - 1.0)
            label = 'Rent-a-Car' -- Blip label
        },
        vehicles = {
            { label = 'Adder', model = 'adder', category = 'car', price = 100, image = 'vehicle.png' }, -- Vehicle list for this location
            { label = 'Banshee', model = 'banshee', category = 'car', price = 80, image = 'vehicle.png' },
        },
    },
}


```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://m4ster.gitbook.io/uniquedevelopment/resources/esx/rental-car-system/config.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
