> ## 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 TStudio Ammunation 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="TStudio Ammunation Map" icon="map" href="https://shop.tstudio3d.com/package/6831887">
        Required map by TStudio
      </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/1GZZMOTHdkT-_GMLU4gWejjnZO4Vjhmu8/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 dispatch starts before the bridge, and the bridge and minigames start before the robbery script.

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

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

    ensure projectx-ammunationrobbery-tstudio
    ```
  </Step>
</Steps>

## Items Required

### Items Required from Outside the Robbery

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

* `ammunation_keycard`

### Items Required from Shop/Black Market

* `x_circuittester`
* `advancedlockpick`
* `x_cyberdeck`
* `x_fingerprinttape`
* `x_stethoscope`
* `x_trojanusb`
* `bag`

<Info>
  The rest of the items (`x_trojanusb2`, `x_fingerprintbag`, etc.) are obtained within the robbery itself.
</Info>

### Item Configuration

<Tabs>
  <Tab title="ox_inventory">
    ```lua theme={null}
    ["bag"] = {
        label = "Duffel Bag",
        weight = 250,
        stack = false,
        close = false,
        description = "Duffel bag",
    },
    ["x_circuittester"] = {
        label = "X Circuit Tester",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["ammunation_keycard"] = {
        label = "Ammunation Keycard",
        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",
    },
    ["x_cyberdeck"] = {
        label = "X Cyberdeck",
        weight = 100,
        stack = false,
        close = false,
        description = "Nothing suspicious about this cyberdeck..",
    },
    ["x_fingerprinttape"] = {
        label = "Fingerprint Tape",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["x_fingerprintbag"] = {
        label = "Fingerprint Bag",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["x_stethoscope"] = {
        label = "X Stethoscope",
        weight = 200,
        stack = false,
        close = false,
        description = "click click",
    },
    ["x_trojanusb"] = {
        label = "X Trojan USB",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["x_trojanusb2"] = {
        label = "X Encrypted Trojan",
        weight = 125,
        stack = false,
        close = false,
        description = "?????????",
    },
    ```
  </Tab>

  <Tab title="qb-inventory">
    ```lua theme={null}
    ['bag'] = {['name'] = 'bag', ['label'] = 'Bag', ['weight'] = 50, ['type'] = 'item', ['image'] = 'bag.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'] = '????'},
    ['ammunation_keycard'] = {['name'] = 'ammunation_keycard', ['label'] = 'Ammunation Keycard', ['weight'] = 200, ['type'] = 'item', ['image'] = 'ammunation_keycard.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'},
    ['x_cyberdeck'] = {['name'] = 'x_cyberdeck', ['label'] = 'X Cyberdeck', ['weight'] = 100, ['type'] = 'item', ['image'] = 'x_cyberdeck.png', ['unique'] = true, ['useable'] = true, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'Nothing suspicious about this cyberdeck..'},
    ['x_fingerprinttape'] = {['name'] = 'x_fingerprinttape', ['label'] = 'Fingerprint Tape', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_fingerprinttape.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['x_trojanusb'] = {['name'] = 'x_trojanusb', ['label'] = 'X Trojan USB', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_trojanusb.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['x_trojanusb2'] = {['name'] = 'x_trojanusb2', ['label'] = 'X Encrypted Trojan', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_trojanusb2.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['x_fingerprintbag'] = {['name'] = 'x_fingerprintbag', ['label'] = 'Fingerprint Bag', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_fingerprintbag.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '????'},
    ['x_stethoscope'] = {['name'] = 'x_stethoscope', ['label'] = 'X Stethoscope', ['weight'] = 200, ['type'] = 'item', ['image'] = 'x_stethoscope.png', ['unique'] = false, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'click click'},
    ```
  </Tab>
</Tabs>