> For the complete documentation index, see [llms.txt](https://shredded.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://shredded.gitbook.io/docs/paid-scripts/shr-pawnshop/install.md).

# INSTALL

**SHR Pawnshop** is an ESX FiveM resource that lets players sell configured inventory items for cash at pawnshop locations. It includes a modern NUI menu, **ox\_target** interaction, optional **NPCs** or **box zones**, random per-unit pricing, and an optional **Discord webhook** for sale logging.

**Version:** 1.0.0

## Features

* Sell items for ESX cash (`money` or a custom account)
* Supports **qs-inventory** and **ox\_inventory**
* Random unit price between `priceMin` and `priceMax`
* Custom NUI with inventory item images
* Multiple locations, map blips, ox\_target
* Shopkeeper NPC or zone-only interaction (no NPC)
* Progress bar with animation (cancellable sales)
* Fully configurable locales (`locales/`)
* Discord webhook with player and transaction details

## Requirements

| Resource                                                                | Required    |
| ----------------------------------------------------------------------- | ----------- |
| [es\_extended](https://github.com/esx-framework/esx_core) (ESX)         | Yes         |
| [ox\_target](https://github.com/overextended/ox_target)                 | Yes         |
| [progressbar](https://github.com/SWRP-PUBLIC/progressbar) or compatible | Yes         |
| **qs-inventory** *or* **ox\_inventory**                                 | One of them |

**Server:** FiveM with `fx_version 'cerulean'`, GTA V (`game 'gta5'`).

## Installation

{% stepper %}
{% step %}

## Place the resource

Place the resource in your server, e.g. `resources/[standalone]/shr_pawnshop/`
{% endstep %}

{% step %}

## Ensure dependencies

Ensure dependencies start **before** pawnshop:

```cfg
ensure es_extended
ensure ox_target
ensure progressbar
ensure qs-inventory
# OR ensure ox_inventory
ensure shr_pawnshop
```

{% endstep %}

{% step %}

## Edit `config.lua`

Set inventory type, locations, items, optional webhook
{% endstep %}

{% step %}

## Restart the resource

Restart the resource or server
{% endstep %}

{% step %}

## Use in-game

Go to a pawnshop → ox\_target → **Open pawnshop** → sell items you carry

The menu only shows items from `Config.Items` that the player **currently has** in inventory.
{% endstep %}
{% endstepper %}