> For the complete documentation index, see [llms.txt](https://docs.cdev.shop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cdev.shop/fivem/cdev-horse-shop-redm/installation-guide.md).

# Installation Guide

{% stepper %}
{% step %}

### Install (or update) dependencies and optional

{% hint style="danger" %} <mark style="color:yellow;">**Verify all dependencies below are started**</mark><mark style="color:yellow;">**&#x20;**</mark>*<mark style="color:yellow;">**before**</mark>*<mark style="color:yellow;">**&#x20;**</mark><mark style="color:yellow;">**this script in your**</mark> **`server.cfg`**<mark style="color:yellow;">**.**</mark>
{% endhint %}

#### Required

| Resource      | Purpose                                                                                                                                 |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| **oxmysql**   | Database driver for player data, ranking, and match history. [Download oxmysql](https://github.com/CommunityOx/oxmysql/releases/latest) |
| **Framework** | [VORP ](https://github.com/VORPCORE), Custom.                                                                                           |
| Notify        | VORP, Custom.                                                                                                                           |

#### Optional

| Resource                        | Purpose                                                                                                              |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| Inventory                       | [Vorp\_inventory](https://github.com/VORPCORE/vorp_inventory)                                                        |
| **ox\_target** or **qb-target** | Target-based board interaction (alternative to DrawText) [OX Target RedM](https://github.com/overextended/ox_target) |
| Horse Delivery                  | [vorp\_stables](https://github.com/VORPCORE/VORP-Stables) (Recommended)                                              |
| {% endstep %}                   |                                                                                                                      |

{% step %}

### Install cDev\_horseshop and create a new subfolders or extract folder to server's root

### Install resource from [Portal](https://portal.cfx.re/assets/granted-assets)

**After installing, you should get a zip file with the name shown below.**

* <mark style="color:yellow;">cdev\_horseshop.pack.zip</mark>

{% hint style="info" %}
Create a new subfolder optional step, but is *highly recommended*.
{% endhint %}

**If you haven’t already, create a new subfolder named `[cdev]` in your server’s root resources directory. Unzip (*****extract*****) this script into the newly created `[cdev]` subfolder.**

<div align="left"><figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FdXo5jmybZ0oIpHqmdfo4%2Fexplorer_FKtZ2vHxZq.gif?alt=media&amp;token=f1fbf760-57ca-4452-b457-cc2c2254a511" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

#### ACE permissions (Creator & Admin Manager)

Open your `server.cfg` and add the following ACE permission:

```
add_ace group.admin cdev_horseshop.creator allow
```

**or**

```
add_ace identifier.license:xxxxxxxxxxxx cdev_horseshop.creator allow
```

{% hint style="info" %}
**This permission is required for:**

* **The shop creator flow (placing new shops in the world)**
* **The admin manager command (list all shops, revenue summary, delete branches)**
  {% endhint %}

{% hint style="danger" %} <mark style="color:$warning;">**Important:**</mark> If you changed `Creator.AcePermission` in `public/shared/config.lua`, use that string in `add_ace` instead of `cdev_horseshop.creator`.
{% endhint %}

{% hint style="warning" %}
**Note:** CDEV Horse Shop targets RedM / VORP; permissions are usually kept in `server.cfg`. If your hosting setup uses a separate permissions file (similar to Others framework and `permissions.cfg`), add the same `add_ace` line there instead of cluttering `server.cfg`.
{% endhint %}
{% endstep %}

{% step %}

### Update server.cfg & perform a full restart

Once all other steps are completed, open your `server.cfg` & add `ensure cdev_chess` to the very **bottom** of your resource start list (after oxmysql, your framework, inventory, and target if used). Finally, perform a full server restart. Failure to perform a full restart after installation will cause errors.

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2F4MoFM8MWIbKh1Da8I0dV%2FCode_2kDSMvE0Yp.gif?alt=media&amp;token=47f04e5a-ebdb-4d78-87fb-5ca71b710527" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
Note: When everything is installed, run `/horseshopcreate` in-game to start creating a shop. (Configurable via `Creator.Command` in the shared config.)
{% endhint %}
{% endstep %}

{% step %}

### ⭐ In-Game Preview's / Guides

{% tabs %}
{% tab title="Creating Shop" %}

### Guide how create a Shop

```
/horseshopcreate
```

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FewYue7O9Prc90DyA0LYT%2FCerating%2BShop%2B(1).gif?alt=media&amp;token=1711767e-65f8-4d94-8a1b-c9b0d811b952" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Manager" %}

### Manager Preview

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2F8qPQcezrsfeRWQUPlVTL%2FManager%20Video.gif?alt=media&amp;token=fa94232b-d261-48df-a706-eab70c803bbe" alt=""><figcaption></figcaption></figure>

### Buying Horse From Supplier

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FASBQkLPbddkkaRYjMYJj%2FBuying%2Ba%2BHorse.gif?alt=media&amp;token=762628f3-cf43-43d8-a825-7af6e9ea0ae8" alt=""><figcaption></figcaption></figure>

### Place horse in Showroom

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2F1df5IM4Z6qfPAy4GTKps%2FPlacing%20A%20horse%20in%20Vetrine.gif?alt=media&amp;token=6aae07fd-76b3-4961-af7b-8397d8169a5b" alt=""><figcaption></figcaption></figure>

### Using / Deposit Vault

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FMyMnc3w6vRYft63GZyqo%2FVault%20and%20Deposit.gif?alt=media&amp;token=7affe6a4-c8d6-45e7-b098-4296323c9939" alt=""><figcaption></figcaption></figure>

### Manager Config's

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FGvttspx9wKsZDGdqWiuS%2FDisabling%203D%20Points.gif?alt=media&amp;token=2935d11a-dd37-4db4-9eea-cabb3dcd23d7" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Show Owner" %}

### Simple Shop Owner Command

<pre><code><strong>/myshops
</strong></code></pre>

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FxokPWjGea3wXSvZt6afT%2FRedM_GTAProcess_vOJPKNNzuG.gif?alt=media&amp;token=1670f527-aa31-4216-bdd7-dad0308affdd" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Server Admin" %}

### Admin Menu ( Delete Shops)

```
/horseshopmanager
```

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FCDuORry0LfUWJuSFFshh%2FRedM_GTAProcess_mwTIOr9h5p.gif?alt=media&amp;token=7e9a0bf4-8ae6-445d-bd24-a48a09f4d49f" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Client" %}

### Buying a horse and Preview

<figure><img src="https://1004862655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPhIA9eCA4bwgx77hxx4i%2Fuploads%2FVFq45QYKubztCrgxlU7O%2FBying%2Ba%2BHorse%2BAnd%2BPreview.gif?alt=media&amp;token=b9957644-f670-4975-ad29-58270e015e50" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}