# Install Instructions

***

Follow the steps below to install this resource to your server.

{% stepper %}
{% step %}

## Install dependencies

{% hint style="warning" %}
Verify all dependencies below are started *before* this script in your `server.cfg`.
{% endhint %}

Install (or update) all dependencies below:

1. [oxmysql](https://github.com/overextended/oxmysql/releases/latest)
2. [ox\_lib](https://github.com/overextended/ox_lib/releases/latest)
3. apex\_lib (Included with the purchases - Please check your keymaster)
   {% endstep %}

{% step %}

## Add items <a href="#add-items" id="add-items"></a>

Open the `[install]` folder and add the `items` & their `images` to your inventory

{% hint style="info" %}
Are you on esx - Remember to add the `.sql` to your database.
{% endhint %}

{% tabs %}
{% tab title="ox\_inventory" %}

```lua
-- [INSTALL OX_INVENTORY/DATA/ITEMS.LUA] --
-- [DRINK INGREDIENTS] --
['ice'] = {
    label = 'Ice',
    weight = 10,
},
['pineapplejuice'] = {
    label = 'Pineapple Juice',
    weight = 10,
},
['lemon'] = {
    label = 'Lemon',
    weight = 10,
},
['lime'] = {
    label = 'Lime',
    weight = 10,
},
['sugar'] = {
    label = 'Sugar',
    weight = 10,
},
['mint'] = {
    label = 'Mint',
    weight = 10,
},
['cocomilk'] = {
    label = 'Coco Milk',
    weight = 10,
},

-- [DRINKS] --
['bluelagoon'] = {
    label = 'Blue Lagoon',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a blue lagoon'
    }
},
['caipirinha'] = {
    label = 'Caipirinha',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a Caipirinha'
    }
},
['pinacolada'] = {
    label = 'Pinã Colada',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a Pinã Colada'
    }
},
['maitai'] = {
    label = 'Mai Tai',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a Mai Tai'
    }
},
['mojito'] = {
    label = 'Mojito',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a Mojito'
    }
},
['sanfrancisco'] = {
    label = 'San Francisco',
    weight = 30,
        client = {
        status = { thirst = 200000 },
        anim = { dict = 'mp_player_intdrink', clip = 'loop_bottle' },
        prop = { model = `prop_ld_flow_bottle`, pos = vec3(0.03, 0.03, 0.02), rot = vec3(0.0, 0.0, -1.5) },
        usetime = 2500,
        cancel = true,
        notification = 'You drank a San Francisco'
    }
},
['gin'] = {
    label = 'Gin',
    weight = 30,
},
['rum'] = {
    label = 'Rum',
    weight = 30,
},
['whiskey'] = {
    label = 'Whiskey',
    weight = 30,
},
['vodka'] = {
    label = 'Vodka',
    weight = 30,
},
```

{% endtab %}

{% tab title="qb-inventory" %}
{% code fullWidth="true" %}

```lua
-- [INSTALL QB-CORE/SHARED/ITEMS.LUA] --
-- [DRINK INGREDIENTS] --
ice                         = { name = 'ice',              label = 'Ice',              weight = 10,   type = 'item',   ammotype = nil, image = 'ice.png',              unique = false, useable = true,  description = nil },
pineapplejuice              = { name = 'pineapplejuice',   label = 'Pineapple Juice',  weight = 10,   type = 'item',   ammotype = nil, image = 'pineapplejuice.png',   unique = false, useable = true,  description = nil },
lemon                       = { name = 'lemon',            label = 'Lemon',            weight = 10,   type = 'item',   ammotype = nil, image = 'lemon.png',            unique = false, useable = true,  description = nil },
lime                        = { name = 'lime',             label = 'Lime',             weight = 10,   type = 'item',   ammotype = nil, image = 'lime.png',             unique = false, useable = true,  description = nil },
sugar                       = { name = 'sugar',            label = 'Sugar',            weight = 10,   type = 'item',   ammotype = nil, image = 'sugar.png',            unique = false, useable = true,  description = nil },
mint                        = { name = 'mint',             label = 'Mint',             weight = 10,   type = 'item',   ammotype = nil, image = 'mint.png',             unique = false, useable = true,  description = nil },
cocomilk                    = { name = 'cocomilk',         label = 'Coco Milk',        weight = 10,   type = 'item',   ammotype = nil, image = 'cocomilk.png',         unique = false, useable = true,  description = nil },

-- [DRINKS] --
bluelagoon                  = { name = 'bluelagoon',       label = 'Blue Lagoon',      weight = 30,   type = 'item',   ammotype = nil, image = 'bluelagoon.png',       unique = false, useable = true,  description = nil },
caipirinha                  = { name = 'caipirinha',       label = 'Caipirinha',       weight = 30,   type = 'item',   ammotype = nil, image = 'caipirinha.png',       unique = false, useable = true,  description = nil },
pinacolada                  = { name = 'pinacolada',       label = 'Pinã Colada',      weight = 30,   type = 'item',   ammotype = nil, image = 'pinacolada.png',       unique = false, useable = true,  description = nil },
maitai                      = { name = 'maitai',           label = 'Mai Tai',          weight = 30,   type = 'item',   ammotype = nil, image = 'maitai.png',           unique = false, useable = true,  description = nil },
mojito                      = { name = 'mojito',           label = 'Mojito',           weight = 30,   type = 'item',   ammotype = nil, image = 'mojito.png',           unique = false, useable = true,  description = nil },
sanfrancisco                = { name = 'sanfrancisco',     label = 'San Francisco',    weight = 30,   type = 'item',   ammotype = nil, image = 'sanfrancisco.png',     unique = false, useable = true,  description = nil },
gin                         = { name = 'gin',              label = 'Gin',              weight = 30,   type = 'item',   ammotype = nil, image = 'gin.png',              unique = false, useable = true,  description = nil },
rum                         = { name = 'rum',              label = 'Rum',              weight = 30,   type = 'item',   ammotype = nil, image = 'rum.png',              unique = false, useable = true,  description = nil },
whiskey                     = { name = 'whiskey',          label = 'Whiskey',          weight = 30,   type = 'item',   ammotype = nil, image = 'whiskey.png',          unique = false, useable = true,  description = nil },
vodka                       = { name = 'vodka',            label = 'Vodka',            weight = 30,   type = 'item',   ammotype = nil, image = 'vodka.png',            unique = false, useable = true,  description = nil },
```

{% endcode %}
{% endtab %}

{% tab title="old qb-inventory" %}

```lua
-- [INSTALL QB-CORE/SHARED/ITEMS.LUA] --
-- [DRINK INGREDIENTS] --
["ice"]             = { ["name"] = "ice",             ["label"] = "Ice",             ["weight"] = 10, ["type"] = "item", ["image"] = "ice.png",             ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["pineapplejuice"]  = { ["name"] = "pineapplejuice",  ["label"] = "Pineapple Juice", ["weight"] = 10, ["type"] = "item", ["image"] = "pineapplejuice.png",  ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["lemon"]           = { ["name"] = "lemon",           ["label"] = "Lemon",           ["weight"] = 10, ["type"] = "item", ["image"] = "lemon.png",           ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["lime"]            = { ["name"] = "lime",            ["label"] = "Lime",            ["weight"] = 10, ["type"] = "item", ["image"] = "lime.png",            ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["sugar"]           = { ["name"] = "sugar",           ["label"] = "Sugar",           ["weight"] = 10, ["type"] = "item", ["image"] = "sugar.png",           ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["mint"]            = { ["name"] = "mint",            ["label"] = "Mint",            ["weight"] = 10, ["type"] = "item", ["image"] = "mint.png",            ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["cocomilk"]        = { ["name"] = "cocomilk",        ["label"] = "Coco Milk",       ["weight"] = 10, ["type"] = "item", ["image"] = "cocomilk.png",        ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },

--[DRINKS]--
["bluelagoon"]      = { ["name"] = "bluelagoon",      ["label"] = "Blue Lagoon",     ["weight"] = 30, ["type"] = "item", ["image"] = "bluelagoon.png",      ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["caipirinha"]      = { ["name"] = "caipirinha",      ["label"] = "Caipirinha",      ["weight"] = 30, ["type"] = "item", ["image"] = "caipirinha.png",      ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["pinacolada"]      = { ["name"] = "pinacolada",      ["label"] = "Pinã Colada",     ["weight"] = 30, ["type"] = "item", ["image"] = "pinacolada.png",      ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["maitai"]          = { ["name"] = "maitai",          ["label"] = "Mai Tai",         ["weight"] = 30, ["type"] = "item", ["image"] = "maitai.png",          ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["mojito"]          = { ["name"] = "mojito",          ["label"] = "Mojito",          ["weight"] = 30, ["type"] = "item", ["image"] = "mojito.png",          ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["sanfrancisco"]    = { ["name"] = "sanfrancisco",    ["label"] = "San Francisco",   ["weight"] = 30, ["type"] = "item", ["image"] = "sanfrancisco.png",    ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["gin"]             = { ["name"] = "gin",             ["label"] = "Gin",             ["weight"] = 30, ["type"] = "item", ["image"] = "gin.png",             ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["rum"]             = { ["name"] = "rum",             ["label"] = "Rum",             ["weight"] = 30, ["type"] = "item", ["image"] = "rum.png",             ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["whiskey"]         = { ["name"] = "whiskey",         ["label"] = "Whiskey",         ["weight"] = 30, ["type"] = "item", ["image"] = "whiskey.png",         ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
["vodka"]           = { ["name"] = "vodka",           ["label"] = "Vodka",           ["weight"] = 30, ["type"] = "item", ["image"] = "vodka.png",           ["unique"] = false, ["useable"] = true, ["shouldClose"] = true, ["combinable"] = nil, ["description"] = nil },
```

{% endtab %}

{% tab title="qs-inventory" %}

```lua
-- [DRINK INGREDIENTS] --
['ice'] = {
    name = 'ice',
    label = 'Ice',
    weight = 10,
    type = 'item',
    image = 'ice.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['pineapplejuice'] = {
    name = 'pineapplejuice',
    label = 'Pineapple Juice',
    weight = 10,
    type = 'item',
    image = 'pineapplejuice.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['lemon'] = {
    name = 'lemon',
    label = 'Lemon',
    weight = 10,
    type = 'item',
    image = 'lemon.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['lime'] = {
    name = 'lime',
    label = 'Lime',
    weight = 10,
    type = 'item',
    image = 'lime.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['sugar'] = {
    name = 'sugar',
    label = 'Sugar',
    weight = 10,
    type = 'item',
    image = 'sugar.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['mint'] = {
    name = 'mint',
    label = 'Mint',
    weight = 10,
    type = 'item',
    image = 'mint.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['cocomilk'] = {
    name = 'cocomilk',
    label = 'Coco Milk',
    weight = 10,
    type = 'item',
    image = 'cocomilk.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},

-- [DRINKS] --
['bluelagoon'] = {
    name = 'bluelagoon',
    label = 'Blue Lagoon',
    weight = 30,
    type = 'item',
    image = 'bluelagoon.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['caipirinha'] = {
    name = 'caipirinha',
    label = 'Caipirinha',
    weight = 30,
    type = 'item',
    image = 'caipirinha.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['pinacolada'] = {
    name = 'pinacolada',
    label = 'Pinã Colada',
    weight = 30,
    type = 'item',
    image = 'pinacolada.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['maitai'] = {
    name = 'maitai',
    label = 'Mai Tai',
    weight = 30,
    type = 'item',
    image = 'maitai.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['mojito'] = {
    name = 'mojito',
    label = 'Mojito',
    weight = 30,
    type = 'item',
    image = 'mojito.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['sanfrancisco'] = {
    name = 'sanfrancisco',
    label = 'San Francisco',
    weight = 30,
    type = 'item',
    image = 'sanfrancisco.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['gin'] = {
    name = 'gin',
    label = 'Gin',
    weight = 30,
    type = 'item',
    image = 'gin.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['rum'] = {
    name = 'rum',
    label = 'Rum',
    weight = 30,
    type = 'item',
    image = 'rum.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil'
},
['whiskey'] = {
    name = 'whiskey',
    label = 'Whiskey',
    weight = 30,
    type = 'item',
    image = 'whiskey.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
['vodka'] = {
    name = 'vodka',
    label = 'Vodka',
    weight = 30,
    type = 'item',
    image = 'vodka.png',
    unique = false,
    useable = true,
    shouldClose = true,
    description = nil
},
```

{% endtab %}

{% tab title="ESX" %}

```lua
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('ice', 'Ice', 10, 0, 1),
('pineapplejuice', 'Pineapple Juice', 10, 0, 1),
('lemon', 'Lemon', 10, 0, 1),
('lime', 'Lime', 10, 0, 1),
('sugar', 'Sugar', 10, 0, 1),
('mint', 'Mint', 10, 0, 1),
('cocomilk', 'Coco Milk', 10, 0, 1),
('bluelagoon', 'Blue Lagoon', 10, 0, 1),
('caipirinha', 'Caipirinha', 10, 0, 1),
('pinacolada', 'Pinã Colada', 10, 0, 1),
('maitai', 'Mai Tai', 10, 0, 1),
('mojito', 'Mojito', 10, 0, 1),
('sanfrancisco', 'San Francisco', 10, 0, 1),
('gin', 'Gin', 10, 0, 1),
('rum', 'Rum', 10, 0, 1),
('whiskey', 'Whiskey', 10, 0, 1),
('vodka', 'Vodka', 10, 0, 1);
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

## Add jobs

Open the `[install]` folder and add the `jobs` to your core resource

{% hint style="info" %}
Are you on esx - Remember to add the `.sql` to your database.
{% endhint %}

{% tabs %}
{% tab title="qb-core" %}

```lua
-- [Install into: qb-core/shared/jobs.lua] --
upnatom = {
	label = 'Up N Atom',
	defaultDuty = true,
	offDutyPay = false,
	grades = {
		['0'] = { name = 'Helper', payment = 30 },
		['1'] = { name = 'Cook', payment = 45 },
		['2'] = { name = 'Deliver', payment = 55 },
		['3'] = { name = 'Manager', isboss = true, payment = 60 },
	},
},
```

{% endtab %}

{% tab title="qbx\_core" %}

```lua
-- [Install into: qbx_core/shared/jobs.lua] --   
['upnatom'] = {
        label = 'Up N Atom',
        defaultDuty = true,
        offDutyPay = false,
        grades = {
            [0] = {
                name = 'Helper',
                payment = 50
            },
            [1] = {
                name = 'Cook',
                payment = 75
            },
            [2] = {
                name = 'Deliver',
                payment = 100
            },
            [3] = {
                name = 'Manager',
                isboss = true,
                bankAuth = true,
                payment = 125
            },
        },
    },
```

{% endtab %}

{% tab title="ESX" %}

```lua
INSERT INTO `jobs` (name, label) VALUES
('upnatom', 'Up N Atom');

INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES
('upnatom', 0, 'helper', 'Helper', 30, '{}', '{}'),
('upnatom', 1, 'delivery', 'Delivery', 40, '{}', '{}'),
('upnatom', 2, 'cook', 'Cook', 60, '{}', '{}'),
('upnatom', 3, 'boss', 'Manager', 60, '{}', '{}');
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

## Restart server <a href="#restart-server" id="restart-server"></a>

* Add this script into your main resources directory (usually `../resources`)
* Open `server.cfg` and add `start` or `ensure apex_burgershot`&#x20;
* Restart your server.
  {% endstep %}
  {% endstepper %}

{% hint style="danger" %}
Upon completion, do **not** delete the `[install]` folder or any `.sql` files or you will experience errors.
{% endhint %}
