> ## 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.

# Installation

> Step by step instructions to install the K4MB1 Bobcat Heist resource

## Installation Steps

<Steps>
  <Step title="Install required dependencies">
    <Warning>
      Verify all dependencies below are started **before** this script in your `server.cfg`.
    </Warning>

    <CardGroup cols={2}>
      <Card title="ox_lib" icon="book" href="https://github.com/CommunityOx/ox_lib/releases/latest">
        Download ox\_lib
      </Card>

      <Card title="K4MB1 Bobcat Map" icon="map" href="https://www.k4mb1maps.com/product/6136428">
        Required map by K4MB1
      </Card>

      <Card title="projectx-bridge" icon="bridge" href="/resources/bridge/installation">
        Required Project X Bridge
      </Card>
    </CardGroup>
  </Step>

  <Step title="Install minigames">
    Download the minigames zip and place each resource into your standalone or dependencies folder.

    <Card title="Minigames" icon="gamepad" href="https://drive.google.com/file/d/1EfG_hcQeSiUZZNfMNRgu2nozUHKeLSzS/view?usp=sharing">
      Download and place in your standalone or minigames folder
    </Card>

    <Warning>
      Make sure the minigames are **not** in the same folder as the robbery script.
    </Warning>
  </Step>

  <Step title="Extract and place the resource">
    Extract the script from the zip file and place it into your scripts folder.
  </Step>

  <Step title="Add items to your inventory">
    Add the required items and their images to your inventory resource. See the [items section](#items-required) below for the full list.

    <Info>
      Item images done by [Artwork Inventory](https://discord.gg/Z2awpnXKdw) - Use code **ProjectX** for 10% off!
    </Info>
  </Step>

  <Step title="Configure the resource">
    Open `config/config.lua` and adjust the settings to match your server. The bridge handles framework, inventory, dispatch, and interaction automatically if set to `'auto'`.
  </Step>

  <Step title="Add to server.cfg">
    Make sure the bridge, ox\_lib, your target, dispatch, inventory, minigames, and `mka-lasers` are all started before the robbery script.

    ```cfg theme={null}
    ensure ox_lib
    ensure projectx-bridge

    ensure mka-lasers
    ensure lightsout
    ensure SN-Hacking
    ensure utk_fingerprint

    ensure projectx-bobcatheist-k4mb1
    ```
  </Step>
</Steps>

## Items Required

### Items Required from Outside the Robbery

The `bobcatcard2` must be obtained externally (e.g. from another robbery or side mission) before the heist can be started.

* `bobcatcard2`

### Items Required from Shop/Black Market

* `x_device`
* `x_phone`
* `pliers`
* `bag`

<Info>
  The rest of the items (`bobcatcard`, C4, smoke grenades, etc.) are obtained within the heist itself.
</Info>

### Item Configuration

<Tabs>
  <Tab title="ox_inventory">
    ```lua theme={null}
    ["x_device"] = {
        label = "Flapper Hero",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["bag"] = {
        label = "Duffel Bag",
        weight = 250,
        stack = false,
        close = false,
        description = "Duffel bag",
    },
    ["pliers"] = {
        label = "Pliers",
        weight = 125,
        stack = false,
        close = false,
        description = "A pair of pliers",
    },
    ["x_phone"] = {
        label = "x Phone",
        weight = 300,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["bobcatcard"] = {
        label = "Bobcat Keycard A",
        weight = 50,
        stack = false,
        close = false,
        description = "A Security card for Bobcat",
    },
    ["bobcatcard2"] = {
        label = "Bobcat Keycard B",
        weight = 50,
        stack = false,
        close = false,
        description = "A Security card for Bobcat",
    },
    ```
  </Tab>

  <Tab title="qb-inventory">
    ```lua theme={null}
    ['x_device'] = {['name'] = 'x_device', ['label'] = 'X Device', ['weight'] = 50, ['type'] = 'item', ['image'] = 'x_device.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '?????????'},
    ['bag'] = {['name'] = 'bag', ['label'] = 'Bag', ['weight'] = 400, ['type'] = 'item', ['image'] = 'bag.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'Duffel bag'},
    ['pliers'] = {['name'] = 'pliers', ['label'] = 'Pliers', ['weight'] = 200, ['type'] = 'item', ['image'] = 'pliers.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'Pliers..?'},
    ['x_phone'] = {['name'] = 'x_phone', ['label'] = 'X Phone', ['weight'] = 50, ['type'] = 'item', ['image'] = 'x_phone.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '?????????'},
    ['bobcatcard'] = {['name'] = 'bobcatcard', ['label'] = 'Bobcat Keycard A', ['weight'] = 200, ['type'] = 'item', ['image'] = 'bobcatcard.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = ''},
    ['bobcatcard2'] = {['name'] = 'bobcatcard2', ['label'] = 'Bobcat Keycard B', ['weight'] = 200, ['type'] = 'item', ['image'] = 'bobcatcard2.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = ''},
    ```
  </Tab>
</Tabs>
