---
description: Check the instructions below.
---

# Configuration

The primary configuration files are `config.lua` and `locales/en.lua`.

***

#### General Settings

| Setting       | Description                                                           | Default Value |
| ------------- | --------------------------------------------------------------------- | ------------- |
| `Locales`     | Set the language (`EN` or `TR`).                                      | `"EN"`        |
| `SQLScript`   | Specifies the SQL library (`oxmysql`, `ghmattimysql`, `mysql-async`). | `"oxmysql"`   |
| `MoneyAsItem` | Use money as an item in the server economy.                           | `false`       |
| `MoneyName`   | Name of the money item (if `MoneyAsItem` is `true`).                  | `"cash"`      |

***

#### Interaction Type

| Type       | Description                                         | Default Value |
| ---------- | --------------------------------------------------- | ------------- |
| `textui`   | Use text-based interaction UI.                      | `false`       |
| `drawtext` | Use 3D draw text for interaction prompts.           | `true`        |
| `target`   | Use targeting systems (e.g., QB-Target, Ox-Target). | `false`       |

***

#### Pawnshop Configuration

| Setting        | Description                                     | Example Value         |
| -------------- | ----------------------------------------------- | --------------------- |
| `npcSettings`  | NPC model and spawn location for the pawnshop.  | `{model, coords}`     |
| `blipSettings` | Blip appearance and display name on the map.    | `{id, colour, scale}` |
| `shopSettings` | Whether the shop is NPC-managed or purchasable. | `{npc, price}`        |

**Example Pawnshop Configuration**

```lua
Config.PawnShops = {
    ["Winston's"] = {
        npcSettings = { model = "a_m_m_indian_01", coords = vector4(-1308.5199, -1316.7601, 3.8757, 332.9137) },
        blipSettings = { id = 570, colour = 5, scale = 0.65, displayName = "Winston's Pawn Shop" },
        shopSettings = { npc = false, price = 1000 }
    },
    ["Franklin's"] = {
        npcSettings = { model = "a_m_m_ktown_01", coords = vector4(1696.8640, 3279.0237, 40.1396, 212.6614) },
        blipSettings = { id = 570, colour = 5, scale = 0.65, displayName = "Franklin's Pawn Shop" },
        shopSettings = { npc = false, price = 1000 }
    }
}
```

***

#### Sellable Items

Define items that can be sold at pawnshops, along with pricing and visibility.

| Setting           | Description                                      | Example Value     |
| ----------------- | ------------------------------------------------ | ----------------- |
| `itemCode`        | Internal name of the item.                       | `"weapon_pistol"` |
| `itemLabel`       | Display name of the item.                        | `"Pistol"`        |
| `requiredSelling` | Sales required before the item becomes sellable. | `0`               |
| `defaultPrice`    | Default selling price for the item.              | `1000`            |
| `visibleForNpc`   | Whether the item is visible in NPC markets.      | `true`            |

**Example Item Configuration**

```lua
Config.SellableItems = {
    {
        itemCode = "weapon_pistol",
        itemLabel = "Pistol",
        requiredSelling = 0,
        defaultPrice = 1000,
        visibleForNpc = true
    },
    {
        itemCode = "weapon_assaultrifle",
        itemLabel = "Assault Rifle",
        requiredSelling = 10,
        defaultPrice = 1000,
        visibleForNpc = false
    }
}
```

***

#### NPC Bonus System

Reward players for consistent sales to NPC-managed pawnshops with bonuses.

| Setting                | Description                                   | Example Value |
| ---------------------- | --------------------------------------------- | ------------- |
| `requiredSelling`      | Number of sales required to unlock the bonus. | `10`          |
| `multiplierPercentage` | Percentage bonus applied to item prices.      | `5`           |

**Example NPC Bonus Configuration**

```lua
Config.NPCBonusOptions = {
    {
        requiredSelling = 5,
        multiplierPercentage = 2.5
    },
    {
        requiredSelling = 10,
        multiplierPercentage = 5
    }
}
```

***

#### Localization

The script supports multiple languages through the `locales/en.lua` file.

**Example Localization Keys**

```lua
Locales['EN'] = {
    ['PawnShopSelling'] = 'Pawn Shop',
    ['YouDontHaveItem'] = 'You do not have this item.',
    ['SoldSuccessfully'] = 'Sold "/itemLabel/" for "$/itemPrice/"'
}
```

***
