> For the complete documentation index, see [llms.txt](https://rz-development.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://rz-development.gitbook.io/docs/getting-started/dependencies.md).

# Dependencies & frameworks

RZ scripts are built to run **standalone where possible**, with optional framework adapters for player identity and display names.

***

## Shared dependencies

| Dependency                 | Used by                   | Purpose                        |
| -------------------------- | ------------------------- | ------------------------------ |
| **oxmysql**                | rz-carplay, rz-stripclubs | MySQL/MariaDB queries          |
| **ox\_lib**                | rz-stripclubs (required)  | Locales, UI helpers, callbacks |
| **rz-sound**               | rz-carplay (required)     | 3D vehicle audio, SyncGroups   |
| **xsound** or **rz-sound** | rz-djbooth                | Booth speaker playback         |

***

## Per-script matrix

| Script        | oxmysql | ox\_lib |  rz-sound  |         xsound         |   SQL   |
| ------------- | :-----: | :-----: | :--------: | :--------------------: | :-----: |
| rz-sound      |    —    |    —    |      —     | replaces via `provide` |    No   |
| rz-carplay    |   Yes   |    —    |   **Yes**  |            —           |   Yes   |
| rz-djbooth    |    —    |    —    | Optional\* |    Yes (listed dep)    |    No   |
| rz-stripclubs | Yes\*\* | **Yes** |      —     |            —           | Yes\*\* |

\* Set `Config.PreferRzSoundSyncGroup = true` in rz-djbooth when rz-sound is installed — recommended for best sync and occlusion.

\*\* rz-stripclubs runs without SQL, but the admin panel (`/admin:stripclub`) requires `sql/install.sql`.

***

## Framework adapters

Scripts that need a player identifier (playlists, requests, etc.) support:

| Value        | Behavior                                                               |
| ------------ | ---------------------------------------------------------------------- |
| `auto`       | Picks the highest-priority adapter whose framework resource is running |
| `standalone` | License identifier — no framework required                             |
| `qbox`       | Qbox / qbx\_core — citizenid                                           |
| `qbcore`     | QB-Core — citizenid                                                    |
| `esx`        | ES Extended — identifier                                               |

Custom adapters live in **`server/custom/`** (escrow-open). Copy an existing adapter and edit exports to match your framework.

* [rz-carplay framework setup](/docs/rz-carplay/framework.md)
* [rz-djbooth framework setup](/docs/rz-djbooth/framework.md)

***

## Target systems (rz-djbooth)

| Value                 | Behavior                                   |
| --------------------- | ------------------------------------------ |
| `auto`                | ox\_target → qb-target → drawtext fallback |
| `ox_target`           | Force ox\_target                           |
| `qb-target`           | Force qb-target                            |
| `standalone_drawtext` | 3D text + key press                        |

***

## Inventory / notify / banking (rz-stripclubs)

rz-stripclubs supports multiple integrations via `config.lua`:

* `Config.Framework` — auto, esx, qbcore, qbox, mythic, standalone
* `Config.Target` — auto, ox\_target, qb-target, standalone\_drawtext
* `Config.Inventory` — auto, ox\_inventory, qs-inventory, standalone
* `Config.Shop` — standalone (NUI) or inventory (ox\_inventory)
* `Config.Notify` — auto, ox\_lib
* `Config.Banking` — auto-detect qb-banking, renewed-banking, esx\_addonaccount, mythic-finance, and more

See [rz-stripclubs configuration](/docs/rz-stripclubs/configuration.md) for the full adapter list.

***

## Escrow-open files

Files you can edit after purchase (not encrypted):

| Script        | Open files                                                                                                     |
| ------------- | -------------------------------------------------------------------------------------------------------------- |
| rz-carplay    | `config.lua`, `server/custom/**/*.lua`                                                                         |
| rz-djbooth    | `config.lua`, `db/booths.json`, `server/custom/**`, `client/custom/**`                                         |
| rz-sound      | `config.lua`, export shims, emulators, occlusion, MLO doors                                                    |
| rz-stripclubs | `config.lua`, `db/*.json`, `locales/*.json`, `server/custom/**`, `client/custom/**`, `shared/npc_schedule.lua` |
