> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectx.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Full reference for all configuration options in the K4MB1 Oilrig Heist resource

## config/config.lua

### Main Settings

<ParamField path="debug" type="boolean" default="false">
  Shows polyzones created inside the game.
</ParamField>

<ParamField path="TestingMode" type="boolean" default="false">
  Disables all minigames for flow testing.
</ParamField>

<ParamField path="CrateZOffset" type="number" default="-1.0">
  Vertical offset applied when spawning crate props and interaction zones.
</ParamField>

<ParamField path="ResetHeist" type="number" default="180">
  Minutes before the heist resets after completion.
</ParamField>

<ParamField path="DisableParticles" type="boolean" default="false">
  Disables particle effects during the heist.
</ParamField>

<ParamField path="DisableExplosions" type="boolean" default="true">
  Disables client-side explosions. Set to `false` only if your anticheat allows them.
</ParamField>

<ParamField path="DisableRemovingWeapons" type="boolean" default="false">
  Disables weapon removal during the heist.
</ParamField>

<ParamField path="SpawnNetworkedPropsServerSide" type="boolean" default="true">
  Spawns networked props server side.
</ParamField>

<ParamField path="SpawnNetworkedVehiclesServerSide" type="boolean" default="false">
  Spawns networked vehicles server side when enabled.
</ParamField>

<ParamField path="RequireBag" type="boolean" default="true">
  Requires a `bag` item to collect loot from crates and trolleys.
</ParamField>

<ParamField path="RequiredPlayersNearby" type="table">
  ```lua theme={null}
  RequiredPlayersNearby = {amount = 0, radius = 20.0}
  ```
</ParamField>

***

### Cooldowns, Limits & Bonus

<ParamField path="Cooldown.PlayerCooldown" type="number" default="0">
  Per-player cooldown in minutes after completing the heist.
</ParamField>

<ParamField path="Limits.TotalRobberiesPerRestart" type="number" default="0">
  Server-wide heist cap per restart. `0` disables the limit.
</ParamField>

<ParamField path="Limits.RobberiesPerPlayer" type="number" default="0">
  Per-player heist cap per restart. `0` disables the limit.
</ParamField>

<ParamField path="Bonus" type="table">
  Optional end-of-heist bonus item rolls.
</ParamField>

***

### Dispatch

<ParamField path="DispatchLocation" type="table">
  Choose which step triggers dispatch. Example defaults:

  ```lua theme={null}
  DispatchLocation = {
      ["Fusebox1"] = false,
      ["Laptop1"] = true,
      ["Generator1"] = false,
  }
  ```
</ParamField>

***

### Difficulty Tiers

The heist uses `Easy`, `Medium`, and `Hard` profiles under `Config.Difficulty`. Each tier defines:

<ParamField path="Difficulty.*.SkillLevelRequired" type="number">
  Criminal skill level required to start at that tier.
</ParamField>

<ParamField path="Difficulty.*.PoliceRequired" type="number">
  Minimum police online for that tier.
</ParamField>

<ParamField path="Difficulty.*.Crates" type="number">
  Number of loot crates spawned for the tier.
</ParamField>

<ParamField path="Difficulty.*.Security" type="number">
  Number of armed guards spawned.
</ParamField>

<ParamField path="Difficulty.*.CountDown" type="number">
  Minutes before failing the tier and dropping to an easier profile.
</ParamField>

<ParamField path="Difficulty.*.CrateTimer" type="number">
  Minutes allowed to open crates before they lock.
</ParamField>

***

### Items & Rewards

Item mappings, crate loot tables, trolley payouts, and security loadouts are defined in the lower sections of `config/config.lua`. Update item names to match your inventory and economy.

***

### Evidence, Stress & Logs

<ParamField path="Evidence.Status" type="boolean" default="true">
  Enables fingerprint evidence drops.
</ParamField>

<ParamField path="Stress.Status" type="boolean" default="true">
  Enables stress on minigame failure.
</ParamField>

Logging is configured in `config/logs.lua` (`Enable`, `APIKey`, `FivemanageDataset`).