# Installation

* **Compatible Framework:** QBCore, ESX or Qbox.
* **ox\_lib**: <https://github.com/CommunityOx/ox_lib>
* **Target system (optional):** qb-target or ox\_target
* **AV Gangs** (optional): <https://av-scripts.tebex.io/package/6351957>
* **bl\_ui** (optional, used for hacking minigame): <https://github.com/Byte-Labs-Studio/bl_ui>

## Config Options

* **Mission NPC:** The mission NPC coords are located server side to prevent players from dumping your files and get the info. You can find the code in `server/editable/_npc.lua`
* **Warehouse Setup:** Same as mission NPC, config is in `server/editable/_config.lua` to avoid dumpers. Here you will find the 3 different warehouses and their individual configs like level, item for door, junkchance, guards, crates, etc.
* **Webhook:** Add your own Discord webhook in `server/editable/_webhook.lua` use it to receive a notification when a new warehouse gets generated and everytime a player opens a crate.
* **Rewards:** Every crate model have their own list of possible items, you can edit this list in `server/editable/rewards.lua.` The structure of each reward consist of:
  * **type**:`string` The reward type, can be "item" or "money".
  * **name**:`string` The item or account name.
  * **amount**:`table|number` The amount to add, can be a table with math.random(min,max) or a number.
  * **metadata**:`table` Metadata to add on item, there's already an example in line 54 for item markedbill (used by qb)

### Open Functions

* All open functions like **dispatch, isCop, notifications, Frameworks, Inventories, minigames, etc**. Can be found in `client/editable/` folder and `server/editable/` folder.