> For the complete documentation index, see [llms.txt](https://highqez.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://highqez.gitbook.io/docs/resources/cash-item/installation.md).

# Installation

## Important Steps to Follow

{% hint style="success" %}
The most important part of this installation is to edit the required resource that enables it to run on your server without any issues
{% endhint %}

{% hint style="danger" %}
Ensure that you complete the following task before testing the resource
{% endhint %}

> * ### [#required-resource-adjustments](#required-resource-adjustments "mention")

***

## Download Resource

{% hint style="success" %}
Purchase the script from our [HighQez Store](https://highqez.tebex.io/). After the purchase, the resource will be available in your [Keymaster Account](https://keymaster.fivem.net/asset-grants)
{% endhint %}

Make sure you purchase the script using the same [Keymaster Account](https://keymaster.fivem.net/) that is linked to your server. If not you will receive a warning "**You lack the required entitlement".**

If you receive the error mentioned above, you may have to transfer the resource from the current Keymaster account to the server's Keymaster account using the transfer feature in Keymaster.

***

## Transfer Resource

{% hint style="success" %}
Unzip the downloaded file and transfer it to your server's resource folder
{% endhint %}

If you are using **FTP**, please ensure you use [**WinSCP** ](https://winscp.net/eng/download.php)to transfer the resource to the server. If you use FileZilla, you may encounter the error "**Failed to verify protected resource**"

***

## Start Resource

{% hint style="success" %}
Ensure the resource in server.cfg of your server
{% endhint %}

Make sure to start the resource only after all essential server resources have been started. Follow the example below to **ensure highqez\_cashitem**

```
ensure qb-core #Don't start above this
ensure inventory #Don't start above this

#Start the HighQez resource here

ensure highqez_cashitem

#Start the rest of your resources
```

***

## Resource Items

{% hint style="success" %}
Transfer the item's images from the INSTALL folder of the resource to your server's inventory
{% endhint %}

{% hint style="info" %}
Ensure to add all required **items** to your server
{% endhint %}

<details>

<summary>OLD QBCore</summary>

```lua
['cash'] = {
    ['name'] = 'cash', 					        
    ['label'] = 'Cash', 		   		    
    ['weight'] = 0, 		
    ['type'] = 'item', 		
    ['image'] = 'cash.png', 	 		    
    ['unique'] = false, 		
    ['useable'] = false, 	
    ['shouldClose'] = false,	   
    ['combinable'] = nil,   
    ['description'] = 'Currency'
},
```

</details>

<details>

<summary>NEW QBCore</summary>

```lua
cash = {
    name = 'cash', 					        
    label = 'Cash', 		   		    
    weight = 0, 		
    type = 'item', 		
    image = 'cash.png', 	 		    
    unique = false, 		
    useable = false, 	
    shouldClose = false,	   
    combinable = nil,   
    description = 'Currency'
},
```

</details>

***

## Configure Resource

{% hint style="success" %}
Customize the script to suit the specific requirements of your server
{% endhint %}

Open-source files are available for editing the framework function. The main configuration of the resource is provided below.

<details>

<summary>Config File</summary>

```lua
Config = {}

Config.Currency = { ['cash'] = true, }  -- Name of the currency and item need to be the same

```

</details>

***

## Required Resource Adjustments&#x20;

{% hint style="success" %}
Server resources need to be modified for the proper execution of this script. Follow the instructions below to ensure the script runs smoothly
{% endhint %}

{% hint style="info" %}
Refer to the following tab, which is relevant to your current qb-core and inventory script
{% endhint %}

<details>

<summary>OLD QBCORE</summary>

* Ensure to make edits to **qb-core**
  * **qb-core**: [*View Edited File (GitHub)*](https://github.com/highqez0/qb-core-HIGHQEZ_CASHITEM/commit/ddcd943b0b041d8e7f1981c83db3a6ed0a58df24?diff=unified\&w=0)

**Remember this important information**\
\&#xNAN;*This version **does include** inventory functions such as **AddItem**, **RemoveItem**, and **ClearInventory***

</details>

<details>

<summary>NEW QBCORE</summary>

* Ensure to make edits to **qb-core**
  * **qb-core**: [*View Edited File (GitHub)*](https://github.com/highqez0/qb-core-NEW-HIGHQEZ_CASHITEM/commit/f6411163ab4de50e5d7a476125bb41761f7d05c0)

**Remember this important information**\
\&#xNAN;*This version **does not include** inventory functions such as **AddItem**, **RemoveItem**, and **ClearInventory***

</details>

<details>

<summary>OLD INVENTORY</summary>

* Ensure to make edits to **Inventory**
  * **inventory**: [*View Edited File (GitHub)*](https://github.com/highqez0/ps-inventory-OLD-HIGHQEZ_CASHITEM/commit/3128f134f29b90e0234b40a97f12d55c1a7299fe)

**Remember this important information**\
\&#xNAN;*The editing process is the same for inventories, including **qb-inventory**, **ps-inventory**, and **lj-inventory***

</details>

<details>

<summary>NEW INVENTORY</summary>

* Ensure to make edits to **Inventory**
  * **inventory**: [*View Edited File (GitHub)*](https://github.com/highqez0/qb-inventory-NEW-HIGHQEZ_CASHITEM/commit/f3182a5fd45e3b51eeb33164f4e907c2e022a7d1)

**Remember this important information**\
\&#xNAN;*The editing process is the same for inventories, including **qb-inventory**, **ps-inventory**, and **lj-inventory***

</details>

***

## Resource API

{% hint style="info" %}
Check out the API page to access all APIs for this resource, which can be very useful for **developers**
{% endhint %}

{% content-ref url="/pages/aAyPIMqHOjuE9bWLSGET" %}
[API](/docs/resources/cash-item/api.md)
{% endcontent-ref %}

***