Installation

The steps to correctly install this on your server.

Step 1 - Install Resource

Download the resource from your keymaster, add it to your resources in any folder of your choice.

Step 2 - Inventory Items

ox_inventory

-- Add the below to your `ox_inventory/data/items.lua/`
["thermite"] = {
    label = "Thermite",
    weight = 350,
    stack = true,
    close = true,
    description = "Sometimes you'd wish for everything to burn"
},
['wooden_planks'] = {
    label = 'Wooden Planks',
    weight = 400,
    stack = false,
    description = ""
},
['vent_spyware'] = {
    label = 'Vent Spyware',
    weight = 150,
    stack = false,
    description = ""
},
['breach_charge'] = {
    label = 'Breaching Charge',
    weight = 800,
    stack = false
},
['hotwire_os'] = {
    label = "Hotwire USB",
    weight = 50
},
['tracker_decrypt'] = {
    label = "Tracker Decrypter",
    weight = 150,

qb-inventory

-- Add the below to `qb-core/shared/items.lua/`
wooden_planks = { name = 'wooden_planks', label = 'Wooden Planks', weight = 400, type = 'item', image = 'wooden_planks.png', unique = true, useable = true, shouldClose = true, description = '' },
vent_spyware = { name = 'vent_spyware', label = 'Vent Spyware', weight = 150, type = 'item', image = 'vent_spyware.png', unique = true, useable = true, shouldClose = true, description = '' },
breach_charge = { name = 'breach_charge', label = 'Breach Charge', weight = 800, type = 'item', image = 'breach_charge.png', unique = true, useable = true, shouldClose = true, description = '' },
hotwire_os = { name = 'hotwire_os', label = 'Hotwire USB', weight = 50, type = 'item', image = 'hotwire_os.png', unique = false, useable = true, shouldClose = true, description = '' },
tracker_decrypt = { name = 'tracker_decrypt', label = 'Tracker Decrypter', weight = 150, type = 'item', image = 'tracker_decrypt.png', unique = true, useable = true, shouldClose = true, description = '' }

mythic-inventory

-- Add the below to your `mythic-inventory/items/robbery.lua` (you may have items that already exist such as `thermite`)
{
    name = "wooden_planks",
    label = "Wooden Planks",
    price = 0,
    isUsable = true,
    isRemoved = false,
    isStackable = false,
    isDestroyed = false,
    type = 3,
    rarity = 1,
    closeUi = true,
    metalic = false,
    weight = 10,
},
{
    name = "vent_spyware",
    label = "Vent Spyware",
    price = 0,
    isUsable = true,
    isRemoved = false,
    isStackable = false,
    isDestroyed = false,
    type = 3,
    rarity = 1,
    closeUi = true,
    metalic = false,
    weight = 1,
},
{
    name = "breach_charge",
    label = "Breaching Charge",
    price = 0,
    isUsable = true,
    isRemoved = false,
    isStackable = false,
    isDestroyed = false,
    type = 3,
    rarity = 1,
    closeUi = true,
    metalic = false,
    weight = 2,
},
{
    name = "hotwire_os",
    label = "Hotwire USB",
    price = 0,
    isUsable = true,
    isRemoved = false,
    isStackable = false,
    isDestroyed = false,
    type = 3,
    rarity = 1,
    closeUi = true,
    metalic = false,
    weight = 0.5,
},
{
    name = "tracker_decrypt",
    label = "Tracker Decrypter",
    price = 0,
    isUsable = true,
    isRemoved = false,
    isStackable = false,
    isDestroyed = false,
    type = 3,
    rarity = 1,
    closeUi = true,
    metalic = false,
    weight = 1,
}

esx_inventory

-- Run the below as an SQL query
INSERT INTO `items` (`name`, `label`, `weight`, `limit`, `rare`, `can_remove`, `description`) VALUES
('wooden_planks', 'Wooden Planks', 0.4, 4, 0, 1, ''),
('vent_spyware', 'Vent Spyware', 0.15, 1, 0, 1, ''),
('breach_charge', 'Breach Charge', 0.8, 1, 0, 1, ''),
('hotwire_os', 'Hotwire USB', 0.05, 1, 0, 1, ''),
('tracker_decrypt', 'Tracker Decrypter', 0.15, 1, 0, 1, ''),
('thermite', 'Thermite', 0.2, 1, 0, 1, '"');

Step 3 - Inventory Images

ox_inventory

Add the files from the images/png/ folder to ox_inventory/web/images/

qb-inventory

Add the files from the images/png folder to qb-inventory/html/images/

mythic-inventory

Add the files from images/webp/ folder to mythic-inventory/ui/images/items/

esx_inventory

Add the files from images/png/ to esx_inventory/src/html/img/items/

Step 4 - Dispatch (MYTHIC ONLY)

If you aren't using Mythic Framework, you can skip to step 5.

-- Add the below to the `predefined` table in `mythic-mdt/server/alerts/events.lua`
dealershipnetwork = {
    code = "10-17",
    title = "Suspicious Network Activity",
    type = 1,
    isPanic = false,
    blip = {
        icon = 629,
        size = 1.2,
        color = 26,
        duration = (60 * 5),
    },
},
dealershiprobbery = {
    code = "10-68",
    title = "Dealership Robbery",
    type = 1,
    isPanic = false,
    blip = {
        icon = 570,
        size = 1.2,
        color = 49,
        duration = (60 * 5),
    },
},
dealershipvehicle = {
    code = "10-50",
    title = "Stolen Dealership Vehicle",
    type = 1,
    isPanic = false
},

Step 5 - Config

Head to ff_dealerheist/config/config.lua and then you will start setting you servers information.

1. Set Config.Framework to your framework (Qbox, QB, ESX or Mythic)

2. Set Config.Inventory to your inventory (ox_inventory, qb-inventory, esx_inventory, mythic-inventory)

3. Set Config.Target to your target (ox_target, qtarget, qb-target or mythic-targeting)

4. Set Config.VehicleKeys to your keys resource.

There are a variety of other config options with comments on what each option does, that you will need to finetune to your servers exact needs.

Step 6 - Minigame Colours

If you wish to change the colour of the minigames, rather than editing CSS you can just edit the ox_lib theme convars and that will automatically be applied to the minigames.

You can find out how to do that here.

Step 7 - Ensuring Resource

Open your server.cfg file and at the bottom of your resources make sure to ensure the reason by typing ensure ff_dealerheist and then saving your file.