# Configuration

## Config

Complete config.lua

***

### Basics

#### Language

```lua
Config.Language = 'en'
```

| Value | Description |
| ----- | ----------- |
| `en`  | English     |
| `de`  | German      |

### OXTarget

```lua
Config.UseOxTarget = false
```

### Interact

```lua
Config.InteractKey = 38
```

{% hint style="info" %}
Keybinds your find at <https://docs.fivem.net/docs/game-references/controls/>
{% endhint %}

### Plate prefix

```lua
Config.PlatePrefix = "RENT"
```

### Commands

```lua
Config.StopRentCommandEnabled = false
Config.StopRentKeybind = false
```

{% hint style="info" %}
Enable /stoprent command (only for players without access to the admin panel)\
Enable keybind to stop rental (only for players without access to the admin panel)
{% endhint %}

### Rent times

```lua
Config.RentTimes = { 15, 30, 60 }
```

```lua
Config.ExtendStep = 5 
```

{% hint style="info" %}
Extension step in minutes (e.g. 5 = extend rental by 5 minutes per purchase)
{% endhint %}

### Ped logo

```lua
Config.PedLogo = {
    enabled     = true,             -- Enable logo (true/false)
    textureDict = "carrent",        -- Texture dictionary (stream/carrent.ytd)
    textureName = "carrent",        -- Texture name (must match the texture name inside the YTD)
    offsetZ     = 1.25,             -- Height above ped head
    width       = 0.095,            -- Sprite width
    height      = 0.15,             -- Sprite height
    alpha       = 255,              -- Transparency (0-255)
    maxDistance = 20.0,             -- Visible distance in meters
    scaleNear   = 1.8,              -- Scale when close to ped
    scaleFar    = 1.0,              -- Scale at maximum distance
    rentIds     = {},               -- e.g. { "sandy", "lsc" } or {} for all locations
}
```

{% hint style="info" %}
Logo above ped heads\
rentIds: Rental IDs where the logo appears. Empty ({}) = all locations.
{% endhint %}

### Admin groups

```lua
Config.AdminGroups = { "admin", "superadmin" }
```

### Blips

```lua
Config.Blipname = "Carrent" -- Blip text
Config.BlipSprite = 225 -- Icon/Sprite
Config.BlipColor = 17 -- Color
Config.BlipScale = 0.8 -- Scale/Size
Config.BlipShortRange = true -- Short range (only visible when nearby)
```

### Ped protection

```lua
Config.PedHitWarnAt   = 2   -- Warning is shown after this hit count
Config.PedHitBanAt    = 3   -- Player gets banned starting from this hit count
```

### Funny ped sound

```lua
Config.PedHitSound    = true
Config.PedHitSoundUrl = "https://youtu.be/dQw4w9WgXcQ?si=mA1Csxgap9rDHbG4"
```

{% hint style="info" %}
Funny sound on ped ban ([xsound ](https://github.com/Xogy/xsound)required)
{% endhint %}

### Givekey event

```lua
Config.GiveKeyEvent = "your-key-system"
```

{% hint style="info" %}
For example, Jaksam Vehicle Keys, Quasar Vehicle Keys, etc.
{% endhint %}

### LB-Phone App intergration&#x20;

```lua
Config.PhoneAppName = "sq-carrent"
Config.LBPhoneApp = false
```

{% hint style="warning" %}
Works only with the VARIX LB App!
{% endhint %}


---

# Agent Instructions: 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://varixcode.gitbook.io/varixcode/varixcode-series/vlrixcode-carrent/configuration.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.