> For the complete documentation index, see [llms.txt](https://docs.cuxial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cuxial.com/scripts/getting-started/requirements.md). # Requirements What your server needs before installing a Cuxial script, what each script adds and the order to start it in. Cuxial scripts share one base: OneSync, three shared resources and a supported framework. You set it up once. Some scripts add requirements of their own, listed in [Requirements per script](#requirements-per-script). ## Server | Requirement | Notes | | ------------------------- | ------------------------------------------------------------------------------------------------- | | FXServer for GTA V | The scripts declare `fx_version 'cerulean'` and `game 'gta5'`. Use a recent recommended artifact. | | OneSync | Required. Most scripts declare it as a dependency and will not start without it. | | MySQL or MariaDB database | Used through `oxmysql`. | Enable OneSync from txAdmin, or in your server configuration: ```cfg set onesync on ``` ## Shared resources | Resource | Why | | --------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `ox_lib` | Callbacks, translations and common utilities. | | `oxmysql` | Database access. | | `cuxial_bridge` | Connects the scripts to your framework, inventory and target. See [Cuxial Bridge](/scripts/getting-started/cuxial-bridge.md). | Every script requires all three, with two exceptions: Cuxial Pause Menu does not use `oxmysql`, and Cuxial Gang App does not declare `cuxial_bridge` (it depends on `qbx_core` and Cuxial Gang directly). ## Framework, inventory and target Cuxial Bridge detects what your server runs. These are the supported options: | Layer | Supported | | --------- | ---------------------------------------------------------- | | Framework | QBox (`qbx_core`), QBCore (`qb-core`), ESX (`es_extended`) | | Inventory | `ox_inventory`, `qb-inventory` | | Target | `sleepless_interact`, `ox_target`, `qb-target` | A framework is always required. Inventory and target only matter for scripts that use them; some scripts need one in particular, as the tables below show. {% hint style="warning" %} Some scripts require a specific framework. Cuxial Multichar requires QBox or QBCore. Check the table below before you buy or install. {% endhint %} ## Framework compatibility The frameworks each script runs on. | Script | QBox | QBCore | ESX | Notes | | ----------------------------------------------------------------- | ---- | ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | [Cuxial Multichar](/scripts/core/cuxial-multichar.md) | Yes | Yes | No | Requires QBox or QBCore. | | [Cuxial Appearance](/scripts/core/cuxial-appearance.md) | Yes | Yes | Partial | On ESX the creator starts on the male model. | | [Cuxial Banking](/scripts/core/cuxial-banking.md) | Yes | Yes | Partial | On ESX the transaction history records the movements made through Cuxial Banking. | | [Cuxial Garages](/scripts/core/cuxial-garages.md) | Yes | Yes | Yes | On ESX it adds columns to `owned_vehicles` on first start. | | [Cuxial License](/scripts/core/cuxial-license.md) | Yes | Yes | Partial | The character's birth date, nationality and gender are read on QBox and QBCore. | | [Cuxial Interactions](/scripts/core/cuxial-interactions.md) | Yes | Yes | Partial | `usePlayerSkin` requires QBox or QBCore. | | [Cuxial Safezones](/scripts/core/cuxial-safezones.md) | Yes | Yes | Yes | | | [Cuxial Admin](/scripts/core/cuxial-admin.md) | Yes | No | No | Requires `qbx_core`. | | [Cuxial Chat](/scripts/interface/cuxial-chat.md) | Yes | Yes | Yes | | | [Cuxial Emotes](/scripts/interface/cuxial-emotes.md) | Yes | Yes | Yes | | | [Cuxial Pause Menu](/scripts/interface/cuxial-pausemenu.md) | Yes | Yes | Partial | On ESX the duty counters go by job name. The gang tag is shown on QBox and QBCore. | | [Cuxial Announcements](/scripts/interface/cuxial-anuncios.md) | Yes | Yes | Yes | | | [Cuxial Police](/scripts/police-and-medical/cuxial-police.md) | Yes | Partial | Partial | Changing a rank from the staff page requires multi-job support. Duty on ESX requires a version whose jobs carry an on-duty state. | | [Cuxial Medical](/scripts/police-and-medical/cuxial-medical.md) | Yes | Yes | Partial | On ESX it needs player metadata (`getMeta` / `setMeta`) and a duty flag on the job. | | [Cuxial Diseases](/scripts/police-and-medical/cuxial-diseases.md) | Yes | Yes | Partial | On ESX, set `onboarding.enabled = false`. | | [Cuxial Gang](/scripts/gangs/cuxial-gang.md) | Yes | Yes | No | Requires QBox or QBCore. | | [Cuxial Gang App](/scripts/gangs/cuxial-gang-app.md) | Yes | No | No | Requires `qbx_core`. | | [Cuxial Fuel](/scripts/vehicles/cuxial-fuel.md) | Yes | Yes | Yes | On ESX, job discounts need a version that reports duty status. | | [Cuxial Gas Stations](/scripts/vehicles/cuxial-gasstations.md) | Yes | Yes | Yes | | | [Cuxial Chipeo](/scripts/vehicles/cuxial-chipeo.md) | — | — | — | Uses the framework through Cuxial Bridge. | | [Cuxial Diving](/scripts/jobs/cuxial-diving.md) | Yes | Yes | Yes | | | [Cuxial Electrician](/scripts/jobs/cuxial-electrician.md) | Yes | Yes | Yes | | | [Cuxial Gardener](/scripts/jobs/cuxial-gardener.md) | Yes | Yes | Yes | | | [Cuxial Gym](/scripts/leisure/cuxial-gym.md) | — | — | — | Uses the framework through Cuxial Bridge. | | [Cuxial Dance Class](/scripts/leisure/cuxial-danceclass.md) | Yes | Yes | Yes | | | [Cuxial Domino](/scripts/leisure/cuxial-domino.md) | Yes | Yes | Yes | | **Yes**: supported. **Partial**: it runs, as described in Notes. **No**: it requires another framework. **—**: it uses the framework Cuxial Bridge detects. The details of each "Partial" are on the script's Overview and Installation pages. ## Requirements per script The common base is enough for some scripts. Others declare extra dependencies and do not start without them. Optional integrations are detected when they are running: if one is missing, that part stays off and everything else works the same. | Script | Also required | Optional integrations | | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Cuxial Multichar](/scripts/core/cuxial-multichar.md) | None | `cuxial_appearance` or `illenium-appearance`, `cuxial_emotes`, `cuxial_license`, `cuxial_garages`, `av_weather`, `qbx_properties` | | [Cuxial Appearance](/scripts/core/cuxial-appearance.md) | None | Inventory and target (garments as items, outfit bag), `cuxial_appearance_photos`, `screencapture` or `screenshot-basic`, `cuxial_emotes`, `rcore_tattoos` | | [Cuxial Banking](/scripts/core/cuxial-banking.md) | An inventory and a target supported by the bridge | `cuxial_interactions` | | [Cuxial Garages](/scripts/core/cuxial-garages.md) | None | `ox_inventory` (recommended; needed while the key system is enabled), `ox_target`, `cuxial_gang`, `cuxial_police`, `cuxial_license`, `cuxial_fuel`, `lb-phone`, `jg-dealerships`, `rahe-speakers` | | [Cuxial License](/scripts/core/cuxial-license.md) | `screencapture`. `ox_inventory` for the card items and a target for the office NPC | Fivemanage account (photos), `cuxial_police`, `av_weather` | | [Cuxial Interactions](/scripts/core/cuxial-interactions.md) | `ox_inventory`. One target: `sleepless_interact`, `ox_target` or `qb-target` | `cuxial_appearance`, `cuxial_medical`, `bl_sprites` | | [Cuxial Safezones](/scripts/core/cuxial-safezones.md) | None | `ox_inventory` | | [Cuxial Admin](/scripts/core/cuxial-admin.md) | `qbx_core` | `cuxial_medical`, `cuxial_appearance`, `cuxial_garages`, `cuxial_multichar`, `cuxial_cmservices`, `cuxial_emotes`, `av_weather` or `prim_climatime`, txAdmin | | [Cuxial Chat](/scripts/interface/cuxial-chat.md) | None | `cuxial_gang` | | [Cuxial Emotes](/scripts/interface/cuxial-emotes.md) | None | `cuxial_emotes_dlc`, `cuxial_diseases`, `ox_inventory` | | [Cuxial Pause Menu](/scripts/interface/cuxial-pausemenu.md) | None | None | | [Cuxial Announcements](/scripts/interface/cuxial-anuncios.md) | None | None | | [Cuxial Police](/scripts/police-and-medical/cuxial-police.md) | `pma-voice` | `ox_inventory` (recommended), `screencapture`, `cuxial_medical`, `cuxial_diseases`, `cuxial_gang`, `cuxial_banking`, `cuxial_license`, `cuxial_garages`, `cuxial_interactions`, `lb-phone`, `rcore_prison` | | [Cuxial Medical](/scripts/police-and-medical/cuxial-medical.md) | An inventory and a target supported by the bridge | `cuxial_interactions`, `cuxial_police` | | [Cuxial Diseases](/scripts/police-and-medical/cuxial-diseases.md) | `ox_inventory` or `qb-inventory` | `cuxial_police`, `cuxial_medical`, `cuxial_emotes`, `lb-phone` | | [Cuxial Gang](/scripts/gangs/cuxial-gang.md) | `ox_inventory` for the stashes | `cuxial_police`, `cuxial_garages`, `cuxial_medical`, `cuxial_appearance`, `nextgenfivem_crafting`, `lb-phone` | | [Cuxial Gang App](/scripts/gangs/cuxial-gang-app.md) | `qbx_core`, `lb-phone`, `cuxial_gang` | `ox_inventory` | | [Cuxial Fuel](/scripts/vehicles/cuxial-fuel.md) | `sleepless_interact`, `ox_inventory`, `cuxial_gas_assets` | `cuxial_gasstations` | | [Cuxial Gas Stations](/scripts/vehicles/cuxial-gasstations.md) | `sleepless_interact`, `cuxial_gas_assets` | `cuxial_fuel`, `cuxial_garages`, a phone supported by the bridge | | [Cuxial Chipeo](/scripts/vehicles/cuxial-chipeo.md) | `ox_inventory` for the items and a target for the portable speakers | None | | [Cuxial Diving](/scripts/jobs/cuxial-diving.md) | `sleepless_interact`, `cuxial_jobs`, `cuxial_diving_assets` | `cuxial_garages` | | [Cuxial Electrician](/scripts/jobs/cuxial-electrician.md) | `sleepless_interact`, `cuxial_jobs` | `cuxial_garages` | | [Cuxial Gardener](/scripts/jobs/cuxial-gardener.md) | `sleepless_interact`, `cuxial_jobs`, `cuxial_gardener_assets` | `cuxial_garages`, `ox_inventory` or `qb-inventory` (item rewards) | | [Cuxial Gym](/scripts/leisure/cuxial-gym.md) | `sleepless_interact`, `cuxial_gym_assets` | `ox_inventory` (recommended; lockers and stashes need it), `cuxial_appearance` | | [Cuxial Dance Class](/scripts/leisure/cuxial-danceclass.md) | `cuxial_emotes` | `cuxial_gym` | | [Cuxial Domino](/scripts/leisure/cuxial-domino.md) | `sleepless_interact` | None | {% hint style="info" %} `cuxial_jobs` and the asset packs (`cuxial_gas_assets`, `cuxial_gym_assets`, `cuxial_diving_assets`, `cuxial_gardener_assets`) are delivered with the script that uses them. See [Cuxial Jobs](/scripts/getting-started/cuxial-jobs.md). {% endhint %} What each resource is used for, and what happens without it, is in the requirements table of each script's Overview page. ## Start order Dependencies first, then your framework, then Cuxial Bridge, then libraries and assets, then the scripts. {% tabs %} {% tab title="QBox" %} {% code title="server.cfg" %} ```cfg ensure oxmysql ensure ox_lib ensure qbx_core ensure ox_inventory ensure ox_target ensure cuxial_bridge # libraries and assets of your scripts (cuxial_jobs, cuxial_*_assets) # your Cuxial scripts here ``` {% endcode %} {% endtab %} {% tab title="QBCore" %} {% code title="server.cfg" %} ```cfg ensure oxmysql ensure ox_lib ensure qb-core ensure qb-inventory ensure qb-target ensure cuxial_bridge # libraries and assets of your scripts (cuxial_jobs, cuxial_*_assets) # your Cuxial scripts here ``` {% endcode %} {% endtab %} {% tab title="ESX" %} {% code title="server.cfg" %} ```cfg ensure oxmysql ensure ox_lib ensure es_extended ensure ox_inventory ensure ox_target ensure cuxial_bridge # libraries and assets of your scripts (cuxial_jobs, cuxial_*_assets) # your Cuxial scripts here ``` {% endcode %} On ESX, start only the scripts marked "Yes" or "Partial" in [Framework compatibility](#framework-compatibility). {% endtab %} {% endtabs %} The inventory and target lines are examples. Keep the ones your server already uses, and only list the scripts you own. The exact `ensure` lines of each script are on its Installation page. {% hint style="warning" %} Libraries and assets (`cuxial_jobs`, `cuxial_*_assets`) must start **before** the script that uses them. The same applies to any other extra requirement (`sleepless_interact`, `pma-voice`, `screencapture`, `lb-phone`) and to a Cuxial script another one depends on: Cuxial Emotes before Cuxial Dance Class, Cuxial Gang before Cuxial Gang App. {% endhint %} {% hint style="warning" %} Your framework, inventory and target must start **before** the Cuxial scripts. Detection happens when each script loads; anything started later is not seen, and the script falls back to QBox, `ox_inventory` and `ox_target`. {% endhint %} {% hint style="info" %} If you start resources by folder (`ensure [cuxial]`), the order inside the folder is not guaranteed. Start your framework, inventory, target and `cuxial_bridge` with their own `ensure` lines above it. {% endhint %} ## Next Set up [Cuxial Bridge](/scripts/getting-started/cuxial-bridge.md), then open the installation page of your script. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.cuxial.com/scripts/getting-started/requirements.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.