Rent a Car: Configuration

All options live in config/config.lua. The file returns one table; the sections below follow its order. Durations are in seconds unless noted, distances in meters and money in whole dollars.

GeneralCopy Anchor Link

Debug = false,
Framework = "auto",
Notifications = "auto",
VehicleKeys = "auto",

FuelCopy Anchor Link

Fuel = {
    system = "auto",
    level = 100.0,
},

Company and UICopy Anchor Link

CompanyName = "Los Santos Rent a Car",

UI = {
    accent = "#fafafa",
    numberLocale = "en-US",
    currency = "$",
},

ImageUrl = "https://docs.fivem.net/vehicles/%s.webp",

The phone app takes CompanyName and UI from here as well, so both look the same.

PaymentCopy Anchor Link

PaymentAccounts = { "cash", "bank" },

Prices are always calculated on the server from the config. The total is rent + deposit, plus Remote.fee for phone rentals, and it is charged from the selected account in one step.

LicenseCopy Anchor Link

Whether players need a driver license to rent, at the office and from the phone.

License = {
    required = true,
    check = "any",
    metadata = "driver",
    item = "driver_license",
},

The item check works with ox_inventory, qb-inventory, ps-inventory, codem-inventory, core_inventory, jpr-inventory, origen_inventory and tgiann-inventory, and falls back to the framework inventory.

Rental rulesCopy Anchor Link

MaxActiveRentals = 1,
PlatePrefix = "RENT",
CheckInterval = 30,
ExpireWarning = 5,

DepositCopy Anchor Link

The deposit is set per vehicle and paid back when the vehicle is returned at an office.

A phone rental that is returned before it was picked up gets the full deposit back. A rental whose vehicle is missing on return gets nothing back when damageDeduction is on.

RespawnCopy Anchor Link

When a picked up rental's vehicle is deleted while time is left, it can be spawned again.

Respawn = {
    enabled = true,
    remote = true,
    fee = 250,
    maxDistance = 40.0,
},

Rentals with less than a minute left cannot be respawned or picked up.

RemoteCopy Anchor Link

Phone rentals through hype-rentacar-app. No vehicle is spawned when renting; the player collects it at any office that offers the model.

SecurityCopy Anchor Link

On top of this, only one request per player runs at a time, and vehicles, durations, accounts, office distances and rental ownership are checked on the server.

DurationsCopy Anchor Link

Rental durations in real-time hours, with an optional discount in percent.

Durations = {
    { hours = 1 },
    { hours = 2 },
    { hours = 4,  discount = 5 },
    { hours = 8,  discount = 10 },
    { hours = 24, discount = 20 },
},

The rent is price × hours × (100 - discount) / 100, rounded to whole dollars.

VehiclesCopy Anchor Link

Every rentable vehicle. Offices offer all of them unless they list their own.

Vehicles = {
    { model = "blista", label = "Dinka Blista",     category = "compact",    price = 60,  deposit = 400 },
    { model = "sultan", label = "Karin Sultan",     category = "sport",      price = 220, deposit = 2000 },
    { model = "bati",   label = "Pegassi Bati 801", category = "motorcycle", price = 160, deposit = 1500, type = "bike" },
},

The included categories are compact, sedan, suv, sport, motorcycle and van. A new category only needs a label in locales/*.json under ui.categories.

CameraCopy Anchor Link

A camera turns to the clerk while the menu is open. Set Camera = false to disable it.

LocationsCopy Anchor Link

Each entry is one rental office with its own clerk, blip, spawn points and vehicle list.

Locations = {
    {
        id = "legion",
        label = "Legion Square",
        coords = vec4(109.95, -1088.62, 29.30, 345.0),
        model = "a_m_y_business_02",
        scenario = "WORLD_HUMAN_CLIPBOARD",
        interaction = "target",
        interactDistance = 2.5,
        maxDistance = 10.0,
        returnRadius = 30.0,
        blip = { enabled = true, sprite = 225, color = 5, scale = 0.75 },
        spawns = {
            vec4(111.37, -1081.27, 28.79, 340.0),
            vec4(107.46, -1079.87, 28.79, 340.0),
            vec4(103.62, -1078.53, 28.79, 340.0),
        },
        vehicles = nil,
    },
},

A vehicle is returned at any office, not only where it was rented. A phone rental can only be collected at an office that offers its model.

LocalesCopy Anchor Link

The language comes from ox_lib, so it is set in server.cfg rather than in the config:

setr ox:locale "en"

en and tr are included. To add a language, copy locales/en.json, translate it, save it with the language code as its name (e.g. de.json) and set ox:locale to that code. The Lua side and the menu share the same file.

Building the UICopy Anchor Link

The menu ships prebuilt in web/build. To change it, edit the Vue source in web/ and rebuild:

cd web
pnpm install
pnpm build