> For the complete documentation index, see [llms.txt](https://royals-store.gitbook.io/royals-store-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://royals-store.gitbook.io/royals-store-docs/documentation/getting-started/compatibility.md).

# Compatibility

What your server needs before installing any RS Store resource.

## Frameworks

| Product               | Folder                  | ESX | QBCore | Qbox |    No framework   |
| --------------------- | ----------------------- | :-: | :----: | :--: | :---------------: |
| Advanced Store        | `Advanced_Store`        |  ✅  |    ✅   |   ✅  | ✅ standalone mode |
| Advanced Player Store | `Advanced_Player_Store` |  ✅  |    ✅   |   ✅  |         ❌         |
| Advanced Banking      | `Rs_Banking`            |  ✅  |    ✅   |   ✅  |         ❌         |
| Advanced CryptoMining | `Rs_CryptoMining`       |  ✅  |    ✅   |   ✅  |         ❌         |
| Advanced SolarPanel   | `Rs_SolarPanel`         |  ✅  |    ✅   |   ✅  |         ❌         |

All of them detect your framework on start (`Config.Framework = 'auto'`) **except Advanced CryptoMining**, where you must set `Config.Framework` to `'ESX'`, `'QBCORE'` or `'QBOX'` yourself in `shared/config.lua`.

{% hint style="warning" %}
Three products ship in a folder named differently from their store listing. The folder name is what the resource checks on start — **never rename it to match the product name.**
{% endhint %}

{% hint style="info" %}
**Qbox** is handled through the QBCore-compatible API (`qbx_core`), so anything documented for QBCore applies to Qbox unless a page says otherwise.
{% endhint %}

## Dependencies

### Required

| Resource              | Needs                                              |
| --------------------- | -------------------------------------------------- |
| Advanced Store        | nothing — it runs on its own                       |
| Advanced Player Store | `Advanced_Store`, `oxmysql`                        |
| Rs Banking            | `oxmysql`, `ox_lib`, an inventory, a framework     |
| Rs CryptoMining       | `oxmysql`, `ox_lib`                                |
| Rs SolarPanel         | `oxmysql`, `ox_lib`, `solar_props`, `object_gizmo` |

### Optional

| Dependency                                                                                | Used by                               | For                                                      |
| ----------------------------------------------------------------------------------------- | ------------------------------------- | -------------------------------------------------------- |
| `ox_lib`                                                                                  | Advanced Store                        | nicer notifications and TextUI                           |
| `ox_target` / `qb-target`                                                                 | all three                             | target-based interaction instead of markers              |
| `ox_inventory` / `qb-inventory` / `qs-inventory` / `codem-inventory` / `tgiann-inventory` | all three                             | item images, and standalone money mode on Advanced Store |
| `Rs_Banking`                                                                              | Advanced Store, Advanced Player Store | card-terminal payments and company accounts              |
| a dispatch resource                                                                       | Advanced Store, Rs CryptoMining       | police alerts on robberies                               |
| a vehicle-keys resource                                                                   | Advanced Player Store                 | keys for the supply van                                  |
| `t3_lockpick` **or** `qb-lockpick`                                                        | Rs CryptoMining                       | forced entry during a robbery                            |
| `howdy-hackminigame`                                                                      | Rs CryptoMining                       | laptop hack during a robbery                             |
| `mx_fixwiring`                                                                            | Rs CryptoMining                       | wiring repair, only when `Config.FixWiring = true`       |

{% hint style="warning" %}
On Rs CryptoMining, the robbery flow **cannot be completed** without the lockpick and hack minigame resources. The script tells the player and logs a clear console error rather than breaking — but the feature is effectively off until you install them.
{% endhint %}

## Supported dispatch systems

{% tabs %}
{% tab title="Advanced Store" %}
Set in `Config.Robbery.dispatch.system`:

`ps-dispatch` · `qs-dispatch` · `cd_dispatch` · `rcore_dispatch` · `mythic-mdt` · `core_dispatch` · `wasabi_mdt` · `tk_dispatch` · `custom`

`custom` lets you write your own preset in `robbery/dispatch.lua`.
{% endtab %}

{% tab title="Rs CryptoMining" %}
Set in `Config.Robbery.Dispatch.System`:

`ps-dispatch` · `cd_dispatch` · `core_dispatch` · `qs-dispatch` · `rcore_dispatch` · `codem-dispatch` · `thug-dispatch` · `linden_outlawalert` · `custom` · `none`
{% endtab %}
{% endtabs %}

## Items and images

All three resources sell or hand out inventory items. **The item names shipped in the configs are examples** — they must exist in your own inventory's item list, or products will appear without an image and cannot be given to the player.

* Advanced Store — adapt `Config.Products` to your server's items.
* Rs CryptoMining — copy the 9 images from `install/images/` into your inventory's images folder, and use the snippet in `install/` that matches your inventory.

## Server artifacts

Built for the `cerulean` FiveM manifest with `lua54` enabled. Any reasonably recent server artifact works; if you run a build older than a year, update it before opening a support ticket.