# Config Information

**FiveM Robbery Script - Config Documentation**

***

#### General Overview

This document is based on the **config.lua** file prepared for the FiveM robbery script. All settings are detailed to enable customization of the script....

***

#### Police Notification Event

Triggered event for police notifications.

* **Function:** `PoliceNotificationEvent()`
* **Description:** Sends an alarm to the police department when a robbery starts.
  * **Used Event:** `qb-policejob:client:sendPoliceAlert`
  * **Notification Text:**
    * "Pacific Standard Bank is being robbed, respond code 3!"...

***

#### Target Settings

Interaction texts and target name settings.

* **name:** `qb-target and ox_target`
* **TargetText:**
  * **changeClothes:** "Change Clothes"
  * **pickUpBluePrint:** "Pick up blueprint"
  * **placeC4:** "Plant the Bomb"
  * **hackTarget:** "Hack the System"
  * **collectGold:** "Collect the gold"...

***

#### Contracts

Information about contracts to be used for the robbery.

* **Sample Contract:**

  ```
  [1] = {
      name = "Bank Heist",
      category = "Bank Heist",
      cargoType = "BODY ARMOR, PLATES",
      image = "../images/SPOILER_image.png",
      coin = 50,
      requirements = "trackchip",
      slot = 5,
      timeOut = 1800000,
      description = "By starting this heist, you and your team can initiate a detailed bank robbery.",
      event = "frkn-bankheist:start",
      rank = {
          [1] = 'Hacker',
          [2] = 'Drone Operator',
          [3] = 'Saboteur',
          [4] = 'Leader',
          [5] = 'Gun / Fight'
      }
  }
  ...
  ```

***

#### Minigame Difficulty

Difficulty levels for minigames.

* **Selected Difficulty:** `easy`
* **Difficulty Settings:**
  * **easy:** 0.095
  * **medium:** 0.025
  * **hard:** 0.015...    

***

#### Server Mode Explanation

You can configure the server mode to define the difficulty level and the starting point of the heist. The modes available are:

* **Easy Mode:**
  * Starts directly at the **bank entrance**.
  * Skips several missions like preparation tasks.
  * Simplifies the experience for players, making it beginner-friendly.
* **Medium Mode:**
  * Starts at the **bank entrance**, but includes some preparation missions.
  * Balances gameplay difficulty for a moderate challenge.
* **Hard Mode:**
  * Starts from the **very beginning**, including all preparation and setup missions.
  * Provides the full heist experience with increased challenges for seasoned players.

**Example Configuration:**

```lua
ServerMode = "hard" -- Server mode can be "easy", "medium", or "hard".
```

By choosing the mode, you control how players experience the heist, whether they want a simplified approach or the full-fledged heist adventure.

***

#### NPC Settings

NPC and vehicle information to be used during the robbery.

* **bikerNpcs:** Random NPC names for biker gang members.
  * "cs\_clay"
  * "cs\_johnnyklebitz"
  * "g\_m\_y\_lost\_01"
  * "g\_m\_y\_lost\_03"...
* **bikerMotorcycle:** Random motorcycle models for NPCs.
  * "daemon"
  * "hexer"
  * "gargoyle"...
* **spawnPoints:**

```
vector3(1997.13, 3031.04, 47.03),
vector3(1979.85, 3050.03, 50.43),
vector3(1993.12, 3034.06, 47.04)
...
```

***

#### Item List

Items obtained during the robbery.

| **Item**    | **Description**               |
| ----------- | ----------------------------- |
| blueprint   | Item for obtaining blueprints |
| bankcard    | Bank card                     |
| managerkey  | Manager's key                 |
| c4bomb      | C4 bomb                       |
| heisttablet | Tablet required for heist...  |

***

#### Clothing Settings

Changeable character outfits for different areas.

* **Miner Clothes:**
  * TShirt: Model `15`, Texture `0-5`
  * Torso: Model `65`, Texture `0-3`
  * Helmet: Model `59`, Textures `0-10`
* **Airport Clothes:**
  * TShirt: Model `15`, Texture `0,1,3`
  * Torso: Model `65`, Texture `0,1`
  * Helmet: Model `59`, Textures `0,2,5`...

***

#### Minigame Config

Configuration for mini-games.

| **Game**   | **Details**                     |
| ---------- | ------------------------------- |
| riddleGame | Duration: 25 seconds            |
| sosGame    | Duration: 25 seconds            |
| stickGame  | Difficulty: 5, Speed: 1.0       |
| vaultGame  | Align shapes to unlock vault... |

***

#### Ped and Vehicle Spawn Settings

* **Miner Area Vehicles:**

  ```
  [1] = {
      coords = vector3(46.89, -788.02, 17.79),
      heading = 279.93,
      name = "caddy3"
  },
  [2] = {
      coords = vector3(48.01, -785.41, 17.79),
      heading = 279.93,
      name = "caddy3"
  }
  ...
  ```
* **Ped List:**

  ```
  {
      pedModel = "s_m_y_construct_01",
      coords = vector3(160.8720, -567.9612, 22.0394),
      animDict = "amb@world_human_smoking@male@male_a@idle_a",
      animName = "idle_c"
  },
  {
      pedModel = "s_m_y_dockwork_01",
      coords = vector3(171.1705, -565.0425, 22.0210),
      animDict = "amb@world_human_stand_mobile@male@text@base",
      animName = "base"
  }
  ...
  ```

***

#### Robbery Mission Information

| **Mission**       | **Description**                          |
| ----------------- | ---------------------------------------- |
| startInfo         | Go to the miner area and change clothes. |
| bluePrintCounter  | Retrieve blueprints from another table.  |
| goToAirPort       | Go to the target coordinates.            |
| airPlaneExplosion | Reach the plane crash site.              |
| killSecurity      | Eliminate all security guards.           |
| searchManager     | Find and eliminate the bank manager...   |

***

#### Laser Settings

Laser locations on the lower floors.

| **Start Pos**                           | **Finish Pos**                             |
| --------------------------------------- | ------------------------------------------ |
| vector3(-440.8686, 1076.6456, 318.3806) | vector3(-436.3700, 1075.4456, 317.3839)    |
| vector3(-443.1515, 1089.9043, 319.1500) | vector3(-426.6299, 1085.2380, 319.1500)... |
| vector3(-441.7091, 1085.9529, 316.4853) | vector3(-440.9919, 1087.6359, 322.8000)... |

***

#### Lights and Camera Settings

* **Camera:**

  ```
  coords = vector3(-432.35, 1084.99, 328.78), heading = 127.0
  accessCoords = vector3(-430.4785, 1081.6403, 325.9777)
  ...
  ```
* **Lights:**

  ```
  position = vector3(-436.5805, 1084.1691, 326.0814), color = {r = 255, g = 255, b = 255}
  position = vector3(-441.0101, 1078.7220, 326.0814), color = {r = 255, g = 255, b = 255}
  ...
  ```

***