> ## 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 House Robbery V2 resource

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/modhC0JmRHw" title="House Robbery V2 Showcase" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen />

## Installation Steps

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

    <Card title="ox_lib" icon="book" href="https://github.com/CommunityOx/ox_lib">
      Download ox\_lib
    </Card>
  </Step>

  <Step title="Install minigames and optional dependencies">
    The following dependencies are required if you want to use the script as is:

    <CardGroup cols={2}>
      <Card title="K4MB1-Starter-Shells" icon="house" href="https://k4mb1maps.com/product/5015840">
        Free resource by K4MBI for default shells
      </Card>

      <Card title="LevLevLev-Shell" icon="house" href="https://github.com/levdevlev/lev-apartments/archive/refs/heads/main.zip">
        Additional shell resources
      </Card>

      <Card title="Project-X-Burner" icon="mobile-screen" href="https://www.projectx.gg/category/3011102">
        Free resource by Project X
      </Card>

      <Card title="Project-X-Tasks" icon="list-check" href="https://www.projectx.gg/category/3011102">
        Free resource by Project X
      </Card>

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

    <Info>
      **bl\_dialog** is included in the minigames zip with modifications for the contracts system.
    </Info>

    <Warning>
      Make sure they 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="Configure the resource">
    Open `config.lua` and adjust the settings to your liking. Make sure to change the Framework, Inventory, Dispatch, and Target name to match your server setup.
  </Step>

  <Step title="Add to server.cfg">
    Make sure that the Framework, ox\_lib, Target, Dispatch, Inventory, and Minigames are started before the robbery script.

    ```cfg theme={null}
    ensure ox_lib
    ensure projectx-houserobbery
    ```
  </Step>
</Steps>

## Items Required

### Items Required from Shop/Black Market

* `advancedlockpick`
* `x_burner` (if enabled in config)
* `x_tablet` (if enabled in config)
* `x_device`
* `x_stethoscope`
* `glass_cutter`
* `bag`

<Info>
  The rest of the items are obtained within the robbery. Item images done by [Artwork Inventory](https://discord.gg/Z2awpnXKdw) - Use code **ProjectX** for 10% off!
</Info>

### Item Configuration

<Tabs>
  <Tab title="ox_inventory">
    ```lua theme={null}
    ["house_key"] = {
        label = "House Key",
        weight = 100,
        stack = false,
        close = false,
        description = "To unlock the front door",
    },
    ["x_burner"] = {
        label = "Burner Phone",
        weight = 100,
        stack = false,
        close = false,
        description = "Nothing suspicious about this phone..",
    },
    ["x_tablet"] = {
        label = "X Tablet",
        weight = 100,
        stack = false,
        close = false,
        description = "Nothing suspicious about this tablet..",
    },
    ["bag"] = {
        label = "Bag",
        weight = 400,
        stack = false,
        close = false,
        description = "Duffel bag",
    },
    ["x_stethoscope"] = {
        label = "X Stethoscope",
        weight = 200,
        stack = false,
        close = false,
        description = "click click",
    },
    ["x_device"] = {
        label = "X Device",
        weight = 50,
        stack = false,
        close = false,
        description = "?????????",
    },
    ["glass_cutter"] = {
        label = "Glass Cutter",
        weight = 1000,
        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_coffeemaker"] = {
        label = "Coffee Maker",
        weight = 5000,
        stack = true,
        close = false,
        description = "To make that perfect cup of Joe!",
    },
    ["x_microwave"] = {
        label = "Microwave",
        weight = 5000,
        stack = true,
        close = false,
        description = "A microwave - for heating things up!",
    },
    ["x_painting"] = {
        label = "Painting",
        weight = 3000,
        stack = true,
        close = false,
        description = "A beautiful painting - worth a lot!",
    },
    ["x_plush"] = {
        label = "Plush Toy",
        weight = 100,
        stack = true,
        close = false,
        description = "A cute plush toy",
    },
    ["x_toaster"] = {
        label = "Toaster",
        weight = 1000,
        stack = true,
        close = false,
        description = "A kitchen toaster",
    },
    ["laptop"] = {
        label = "Laptop",
        weight = 500,
        stack = true,
        close = false,
        description = "A high-end laptop",
    },
    ["x_printer"] = {
        label = "Printer",
        weight = 5000,
        stack = true,
        close = false,
        description = "A color printer",
    },
    ["emerald_necklace"] = {
        label = "Emerald Necklace",
        weight = 200,
        stack = true,
        close = false,
        description = "",
    },
    ['x_goldenknife'] = {
        label = "X Golden Knife",
        weight = 300,
        stack = false,
        close = false,
        description = "?????????",
    },
    ['x_television'] = {
        label = "X Television",
        weight = 10000,
        stack = false,
        close = false,
        description = "A high-definition television",
    },
    ["x_watch"] = {
        label = "Watch",
        weight = 100,
        stack = true,
        close = false,
        description = "Wrist watch",
    },
    ["x_bananatrophy"] = {
        label = "Banana Trophy",
        weight = 1000,
        stack = false,
        close = false,
        description = "Don't ask..",
    },
    ["x_electricguitar"] = {
        label = "Electric Guitar",
        weight = 1000,
        stack = false,
        close = false,
        description = "Rock on!",
    },
    ["giant_gem"] = {
        label = "Giant Gem",
        weight = 500,
        stack = false,
        close = false,
        description = "A huge sparkling gem",
    },
    ```
  </Tab>

  <Tab title="qb-inventory">
    ```lua theme={null}
    ["house_key"] = {["name"] = "house_key", ["label"] = "House Key", ["weight"] = 100, ["type"] = "item", ["image"] = "house_key.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "To unlock the front door"},
    ["x_burner"] = {["name"] = "x_burner", ["label"] = "Burner Phone", ["weight"] = 100, ["type"] = "item", ["image"] = "x_burner.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "To receive anonymous calls"},
    ['x_tablet'] = {['name'] = 'x_tablet', ['label'] = 'X Tablet', ['weight'] = 100, ['type'] = 'item', ['image'] = 'x_tablet.png', ['unique'] = true, ['useable'] = true, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'Nothing suspicious about this tablet..'},
    ['bag'] = {['name'] = 'bag', ['label'] = 'Bag', ['weight'] = 400, ['type'] = 'item', ['image'] = 'bag.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = 'Duffel bag'},
    ['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"},
    ['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'] = '?????????'},
    ['glass_cutter'] = {['name'] = 'glass_cutter', ['label'] = 'Glass Cutter', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'glass_cutter.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_microwave"] = {["name"] = "microwave", ["label"] = "Microwave", ["weight"] = 5000, ["type"] = "item", ["image"] = "x_microwave.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Heats things up"},
    ["x_coffeemaker"] = {["name"] = "x_coffeemaker", ["label"] = "Coffee Machine", ["weight"] = 5000, ["type"] = "item", ["image"] = "x_coffeemaker.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Makes a delicious expresso"},
    ["x_painting"] = {["name"] = "x_painting", ["label"] = "Painting", ["weight"] = 3000, ["type"] = "item", ["image"] = "x_painting.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Just a work of art,"},
    ["x_plush"] = {["name"] = "x_plush", ["label"] = "Plush Toy", ["weight"] = 100, ["type"] = "item", ["image"] = "x_plush.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "So cute!"},
    ["x_toaster"] = {["name"] = "x_toaster", ["label"] = "Toaster", ["weight"] = 1000, ["type"] = "item", ["image"] = "x_toaster.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Toasts bread"},
    ["laptop"] = {["name"] = "laptop", ["label"] = "Laptop", ["weight"] = 500, ["type"] = "item", ["image"] = "laptop.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "A high-end laptop"},
    ["x_printer"] = {["name"] = "x_printer", ["label"] = "Printer", ["weight"] = 5000, ["type"] = "item", ["image"] = "x_printer.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "A color printer"},
    ["emerald_necklace"] = {["name"] = "emerald_necklace", ["label"] = "Emerald Necklace", ["weight"] = 200, ["type"] = "item", ["image"] = "emerald_necklace.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = ""},
    ['x_goldenknife'] = {['name'] = 'x_goldenknife', ['label'] = 'X Golden Knife', ['weight'] = 50, ['type'] = 'item', ['image'] = 'x_goldenknife.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = false, ['combinable'] = nil, ['description'] = '?????????'},
    ["x_television"] = {["name"] = "x_television", ["label"] = "X Television", ["weight"] = 10000, ["type"] = "item", ["image"] = "x_television.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "A high-definition television"},
    ["x_watch"] = {["name"] = "x_watch", ["label"] = "Watch", ["weight"] = 100, ["type"] = "item", ["image"] = "x_watch.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Wrist watch"},
    ["x_bananatrophy"] = {["name"] = "x_bananatrophy", ["label"] = "Banana Trophy", ["weight"] = 1000, ["type"] = "item", ["image"] = "x_bananatrophy.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Don't ask.."},
    ["x_electricguitar"] = {["name"] = "x_electricguitar", ["label"] = "Electric Guitar", ["weight"] = 1000, ["type"] = "item", ["image"] = "x_electricguitar.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "Rock on!"},
    ["giant_gem"] = {["name"] = "giant_gem", ["label"] = "Giant Gem", ["weight"] = 500, ["type"] = "item", ["image"] = "giant_gem.png", ["unique"] = true, ["useable"] = false, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = "A huge sparkling gem"},
    ```
  </Tab>
</Tabs>
