> 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/core/cuxial-license.md).

# Cuxial License

Licences, ID cards and badges designed in game and carried as inventory items, with the character's data and photo.

Cuxial License is a document system for FiveM. Staff design each licence, ID card or badge in game, and players carry it as an inventory item filled with their character's data and a photo taken in a green-screen studio.

## What it does

* **Card designer in game.** Layout (landscape, portrait, square or badge wallet), colours, logo, background, fields, price and item name. No file editing.
* **Documents as inventory items.** Using the item shows the card on screen with an animation and a prop in hand. Nearby players see it too.
* **Photo studio.** The player is taken to a private green-screen room, frames the shot with the mouse, picks an expression or a pose and captures. The background is removed automatically.
* **Licence office.** An NPC sells the cards you mark as paid.
* **Issuing panel for jobs.** Authorized jobs issue a card to a nearby player, who accepts the request and takes their own photo. The same panel lists what was issued and lets them revoke or restore it.
* **ID check panel.** Lists nearby players and scans one by server id or character identifier: photo, licences and whether each one has expired.
* **Fake ID generator.** A panel that produces a forged card with free text, opened from your own resources.
* **Wanted and dangerous marks** on the card shown, when `cuxial_police` is running.
* **Server exports** to read, issue, revoke and restore licences from an MDT or any other resource.

## Requirements

| Resource           | Required           | Used for                                                                                                              |
| ------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------- |
| `ox_lib`           | Yes                | Commands, key binding, locales                                                                                        |
| `oxmysql`          | Yes                | Card designs and issued licences                                                                                      |
| `cuxial_bridge`    | Yes                | Connects to your framework, inventory and target                                                                      |
| `screencapture`    | Yes                | Takes the photo of the player. See [Installation](/scripts/core/cuxial-license/installation.md#install-screencapture) |
| `ox_inventory`     | For the items      | The card items are used through `ox_inventory` item exports                                                           |
| A target resource  | For the office NPC | `sleepless_interact`, `ox_target` or `qb-target`, through `cuxial_bridge`                                             |
| Fivemanage account | For photos         | Stores the photos. Without a token, cards are issued with no photo                                                    |
| `cuxial_police`    | No                 | Adds the wanted and dangerous marks to the card shown                                                                 |
| `av_weather`       | No                 | Makes the time-of-day selector of the photo session work                                                              |

{% hint style="warning" %}
Cuxial License requires QBox or QBCore. The character data printed on the cards comes from those frameworks.
{% endhint %}

## Pages

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Dependencies, screencapture, items, convars and start order.</td><td><a href="/scripts/core/cuxial-license/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code> and the card options of the designer.</td><td><a href="/scripts/core/cuxial-license/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Commands, keys and who can design, issue and revoke.</td><td><a href="/scripts/core/cuxial-license/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Open the panels and manage licences from your own resources.</td><td><a href="/scripts/core/cuxial-license/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems and how to fix them.</td><td><a href="/scripts/core/cuxial-license/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>


---

# 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/core/cuxial-license.md?ask=<question>&goal=<user_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.