# General Configuration

This guide will help you configure the script to suit your needs, covering all available options in the `config.lua` file. Each setting is explained step by step.

### **1. General Configuration**

**Language**\
Set the language used by the script.

```lua
Config.Language = 'en' -- Available options: 'en' (English), 'fr' (French).
```

**Use Outdated Version**\
Enable this option to suppress alert messages when using an older version of the script.

```lua
Config.UseOutdatedVersion = false -- Set to true if using an outdated script version.
```

***

### 2. Framework Compatibility

If you're using a framework like **ESX**, **QB**, or **OX Inventory**, enable this setting.

```lua
Config.UseFramework = false
```

* When `true`, the system uses the inventory (e.g., weapon usage) instead of command-based interactions.
* Setup instructions for each framework are available on:
  * [ESX Guide](https://docs.rytrak.fr/framework-compatibility/add-a-custom-weapon-on-esx)
  * [QBCore Guide](https://docs.rytrak.fr/framework-compatibility/add-a-custom-weapon-on-qbcore)
  * [OX Inventory Guide](https://docs.rytrak.fr/framework-compatibility/add-a-custom-weapon-on-ox-inventory)

***

### **3. BolaWrap Settings**

**Enable Aim Assist**\
Enable or disable aim assist when using the BolaWrap.

```lua
Config.EnableAimAssist = false -- Set to true to enable aim assist.
```

**Max Shoot Distance**\
Defines the maximum distance allowed to shoot the BolaWrap.

```lua
Config.MaxShootDistance = 20.0 -- Adjust the distance (in meters) players can shoot the BolaWrap.
```

***

### **4. Recharge System**

**Recharge Coordinates**\
Specifies the coordinates for the recharge station and the radius within which the player can recharge.

```lua
Config.Recharge = {
    coords = vector3(-1394.4, -2726.98, 13.94), -- Recharge station coordinates
    radius = 3.0, -- Recharge radius
    quantityPerRecharge = 3, -- Number of BolaWraps recharged per interaction
}
```

***

### **5. Laser System**

**Enable Laser**\
Enable or disable the laser system.

```lua
Config.Laser = {
    enable = true, -- Set to true to enable the laser system
    color = {      -- Customize the laser color (RGBA)
        r = 0,
        g = 255,
        b = 0,
        a = 80
    },
    maxDistance = 150.0 -- Maximum laser distance (in meters)
}
```

***

### **6. Weapon Settings**

**Define Weapon**\
Sets the weapon identifier for the BolaWrap.

```lua
Config.Weapon = `WEAPON_BOLAWRAP` -- BolaWrap weapon identifier
```

**Weapon Display Name**\
The name displayed in the weapon wheel when equipping the BolaWrap.

```lua
Config.BolawrapWeaponName = "BolaWrap" -- Name displayed in the weapon wheel
```

***

### **7. Key Bindings**

**Laser Key**\
Set the key used to toggle the laser.

```lua
Config.Keys.LaserKey = 86 -- Key to toggle the laser
Config.Keys.LaserKeyString = '~INPUT_VEH_HORN~' -- Display name for the laser key
```

**Release Key**\
Set the key used to release the ropes.

```lua
Config.Keys.ReleaseKey = 311 -- Key to release the ropes
Config.Keys.ReleaseKeyString = '~INPUT_REPLAY_SHOWHOTKEY~' -- Display name for the release key
```

**Refill Key**\
Set the key used to refill the BolaWrap.

```lua
Config.Keys.RefillKey = 311 -- Key to refill the BolaWrap
Config.Keys.RefillKeyString = '~INPUT_REPLAY_SHOWHOTKEY~' -- Display name for the refill key
```

***

### **8. Language Library**

Edit the text displayed for different actions in multiple languages.