# Config Settings

## **⚙ Config Settings (frkn-rentacar)**

This section provides detailed explanations of each setting in the `FRKN` configuration file.

***

### **🔧 General Settings**

#### **`FRKN.ServerCallbacks`**

* **Type:** `table`
* Used internally to manage server callbacks for async operations.\
  \&#xNAN;*(No manual changes required.)*

***

#### **`FRKN.VehicleTableName`**

* **Default:** `'player_vehicles'`
* **Description:**\
  The database table where player-owned vehicles are stored.\
  If your framework uses a different table (e.g., `owned_vehicles` in ESX), update this value.

***

#### **`FRKN.ExpireSystem`**

* **Type:** `boolean`
* **Default:** `false`
* **Description:**\
  Enables or disables the vehicle expiration system.
  * **true**: Vehicles not returned within the set time will expire.
  * **false**: No expiration, players can keep rented vehicles indefinitely.

***

#### **`FRKN.AutoExpireDays`**

* **Type:** `number`
* **Default:** `7`
* **Description:**\
  The number of days before a rented vehicle automatically expires (if expiration is enabled).

***

#### **`FRKN.ExpirePenaltyAmount`**

* **Type:** `number`
* **Default:** `2500`
* **Description:**\
  Amount (in $) deducted from the player's bank account if the vehicle is not returned after expiration.

***

#### **`FRKN.GarageName`**

* **Type:** `string`
* **Default:** `'pillboxgarage'`
* **Description:**\
  The garage where rented vehicles will be stored/spawned after a rental transaction.

***

#### **`FRKN.VehicleSpeedUnit`**

* **Type:** `string`
* **Options:** `'kmh'` or `'mph'`
* **Description:**\
  The speed unit displayed in the rental UI and used for mileage tracking.

***

### **👔 Job Settings**

#### **`FRKN.Job.JobName`**

* **Default:** `'rentacar'`
* **Description:**\
  The job name used for the Rent-A-Car system.\
  Players with this job can add vehicles to the rental list and manage rentals.

***

### **🚗 KM & Pricing Settings**

#### **`FRKN.Kmh.KmhControl`**

* **Type:** `boolean`
* **Default:** `true`
* **Description:**\
  Whether to use km/h (`true`) or mph (`false`) in rental calculations.

***

#### **`FRKN.Kmh.MaxKmhValue`**

* **Type:** `number`
* **Default:** `150`
* **Description:**\
  The maximum km/h (or mph) limit that can be selected when renting a car.

***

#### **`FRKN.Kmh.KmhPrice`**

* **Type:** `number`
* **Default:** `1`
* **Description:**\
  Price charged per km driven during the rental.

***

#### **`FRKN.Kmh.DurationPrice`**

* **Type:** `number`
* **Default:** `10`
* **Description:**\
  Price charged per hour of rental time.

***

#### **`FRKN.Kmh.UnlimitedPrice`**

* **Type:** `number`
* **Default:** `500`
* **Description:**\
  Flat price for unlimited mileage rentals.

***

### **🎯 Target & Spawn Settings**

#### **`FRKN.Rent.targetSystem`**

* **Options:** `"qb-target"` or `"ox_target"`
* **Description:**\
  Determines which targeting system is used for interacting with the Rent-A-Car NPC or zone.

***

#### **`FRKN.Rent.targetCoords`**

* **Type:** `vector3`
* **Default:** `vector3(-835.9119, -2350.4626, 14.6904)`
* **Description:**\
  Location of the Rent-A-Car NPC or interaction point.

***

#### **`FRKN.Rent.VehicleSpawnCoord`**

* **Type:** `vector4`
* **Default:** `vector4(-820.4969, -2343.7712, 14.5707, 157.2429)`
* **Description:**\
  Coordinates and heading where rented vehicles will spawn.

***

### **🖥 UI Settings**

#### **`FRKN.InGameUIPlace`**

* **Options:** `'top-left'`, `'top-right'`, `'bottom-left'`, `'bottom-right'`
* **Default:** `'bottom-right'`
* **Description:**\
  Position of the rental in-game UI.

***

### **🎨 Vehicle Colors**

#### **`FRKN.VehicleColors`**

* **Type:** `table`
* **Description:**\
  A list of available paint colors for rented vehicles.\
  Each entry includes:
  * `label`: Display name.
  * `index`: GTA color index.
  * `rgb`: RGB preview values.
  * `price`: Additional cost for the selected color.

Example:

```lua
{label = "Red", index = 27, rgb = { r = 255, g = 0, b = 0 }, price = 150}
```

***

### **🤖 Discord Integration**

#### **`FRKN.BotToken`**

* **Type:** `string`
* **Default:** `""`
* **Description:**\
  Your Discord Bot token (used to fetch player profile images in the UI).
  * Leave empty to disable Discord avatar integration.

***

### **🔑 Vehicle Keys**

#### **`AddVehicleKey(plate)`**

* **Description:**\
  Gives the renter keys to the rented vehicle by triggering:

  ```lua
  TriggerEvent('vehiclekeys:client:SetOwner', plate)
  ```


---

# 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://docs.0resmon.org/0resmon/frkn-resources/frkn-rent-a-car-job/config-settings.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.