# Installation

## What do I need?

* ESX (1.1+) / QBCore, or code your own bridge to work with your framework. (the bridge is fully accessible!)
* [Ox Lib](https://github.com/overextended/ox_lib/releases/) (Required, Works anywhere).

## Optional

Use my free XP system below, or port to another one inside of the bridge!

<https://forum.cfx.re/t/free-pickles-xp-system-standalone-works-with-esx-qb-multicharacter-identifiers/5088064>

## Installation

:warning:Make sure you rename the folder from pickle\_prisons-main to pickle\_prisons prior to installing.:warning:

If you miss this step the script will not function as expected.

Navigate to the "\_\_INSTALL" folder.

## Optional Metadata

***This is not required to use the script, however enables you to generate items with metadata using the .createItem function in the rewards.***

* QBCore
* Ox Inventory
* ESX (Only if your inventory provider allows metadata to be set through "xPlayer.addInventoryItem".

Navigate to the "\_INSTALL" folder.

Import the images in the \_INSTALL/images folder to your inventory image folder. (Varies on framework)

{% tabs %}
{% tab title="ESX Items" %}
Execute the SQL provided inside the \_\_INSTALL folder.
{% endtab %}

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

```lua
["wood"] 					= {["name"] = "wood",  	     		        ["label"] = "Wood",	 		    ["weight"] = 1, 		["type"] = "item", 		["image"] = "wood.png", 				["unique"] = false, 	    ["useable"] = true, 	["shouldClose"] = true,   	["combinable"] = nil,   ["description"] = ""},
["metal"] 					= {["name"] = "metal",  	     		    ["label"] = "Metal",	 		    ["weight"] = 1, 		["type"] = "item", 		["image"] = "metal.png", 				["unique"] = false, 	    ["useable"] = true, 	["shouldClose"] = true,   	["combinable"] = nil,   ["description"] = ""},
["rope"] 					= {["name"] = "rope",  	     		        ["label"] = "Rope",	 		    ["weight"] = 1, 		["type"] = "item", 		["image"] = "rope.png", 				["unique"] = false, 	    ["useable"] = true, 	["shouldClose"] = true,   	["combinable"] = nil,   ["description"] = ""},
["shovel"] 					= {["name"] = "shovel",  	     		    ["label"] = "Shovel",	 		    ["weight"] = 1, 		["type"] = "item", 		["image"] = "shovel.png", 				["unique"] = false, 	    ["useable"] = true, 	["shouldClose"] = true,   	["combinable"] = nil,   ["description"] = ""},
```

{% endtab %}

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

```lua
['wood'] = {
    label = 'Wood',
    weight = 1,
    stack = true,
    close = true,
    description = nil
},

['metal'] = {
    label = 'Metal',
    weight = 1,
    stack = true,
    close = true,
    description = nil
},

['rope'] = {
    label = 'Rope',
    weight = 1,
    stack = true,
    close = true,
    description = nil
},

['shovel'] = {
    label = 'Shovel',
    weight = 1,
    stack = true,
    close = true,
    description = nil
},
```

{% endtab %}
{% endtabs %}