> ## 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 Default Store Robbery 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="projectx-bridge" icon="bridge" href="/resources/bridge/installation">
        Required Project X Bridge
      </Card>
    </CardGroup>

    <Info>
      No custom map is required. This variant uses default GTA store interiors.
    </Info>
  </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/1mPvEB0JnQS74QvFDlT52AiXB_rwvDVtE/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, and minigames are all started before the robbery script.

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

    ensure bl_ui
    ensure pure-minigames
    ensure SN-Hacking
    ensure pd-safe

    ensure projectx-storerobbery-default
    ```
  </Step>
</Steps>

## Items Required

### Items Required from Outside the Robbery

The `x_harddrive` must be obtained externally (e.g. from another robbery or side mission) before a store robbery can be started.

* `x_harddrive`

### Items Required from Shop/Black Market

* `x_device`
* `x_circuittester`
* `storekey`
* `advancedlockpick`

<Info>
  The rest of the items are obtained within the robbery itself.
</Info>

### Item Configuration

<Tabs>
  <Tab title="ox_inventory">
    ```lua theme={null}
    ["x_device"] = {
        label = "X Device",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["x_circuittester"] = {
        label = "X Circuit Tester",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["x_harddrive"] = {
        label = "X Harddrive",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["storekey"] = {
        label = "Store Key",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["advancedlockpick"] = {
        label = "Advanced Lockpick",
        weight = 500,
        stack = true,
        close = true,
        description = "If you lose your keys a lot this is very useful... Also useful to open your beers",
    },
    ```
  </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'] = '?????????'},
    ['x_circuittester'] = {['name'] = 'x_circuittester', ['label'] = 'X Circuit Tester', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_circuittester.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['x_harddrive'] = {['name'] = 'x_harddrive', ['label'] = 'X Hard Drive', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_harddrive.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['storekey'] = {['name'] = 'storekey', ['label'] = 'Store Key', ['weight'] = 200, ['type'] = 'item', ['image'] = 'storekey.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['advancedlockpick'] = {['name'] = 'advancedlockpick', ['label'] = 'Advanced Lockpick', ['weight'] = 500, ['type'] = 'item', ['image'] = 'advancedlockpick.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'If you lose your keys a lot this is very useful... Also useful to open your beers'},
    ```
  </Tab>
</Tabs>