> 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-admin.md).

# Cuxial Admin

Administration panel for FiveM with ranks, reports, sanctions history, audit log and live moderation tools.

Cuxial Admin is an in-game administration panel for your staff: players, reports, sanctions, world controls and a full audit log in one interface. Access is decided by ranks you create and edit from the panel itself.

{% hint style="warning" %}
Cuxial Admin runs on **QBox only**. Its manifest depends on `qbx_core`, so the resource does not start on QBCore or ESX.
{% endhint %}

## What it does

* **Ranks and permissions.** Four starting ranks, editable from the panel. A rank can be given to one character, to a Discord account or to a Discord role.
* **Player actions.** Revive, heal, freeze, kill, teleport, bring, spectate, change model, give job, gang, money or items, open inventories, warn, kick, community service and character kill.
* **Reports.** Players open a report with a command and chat with the staff. Closed reports are stored as transcripts.
* **Sanctions history.** Warnings and kicks issued from the panel, plus bans, kicks and warnings issued from txAdmin.
* **Audit log.** Every staff action is recorded with who, what, on whom and why.
* **Personal tools.** Noclip, god mode, invisibility, infinite ammo, super jump, player blips and names above heads, each with its own key.
* **Vehicles.** Spawn, give to a player, repair, refuel, upgrade, change plate, take keys and delete.
* **World.** Time, weather, time freeze, blackout, server announcements and entity cleanup.
* **Spectate with voice.** While spectating, the staff member hears the target and the players around them.
* **Screen view.** Authorised staff can watch a player's screen live and, if enabled, listen to their microphone.
* **Remote web panel.** Optional connection to an external web panel so staff can work from outside the game.

## Requirements

| Resource                         | Required | Used for                                                                                                       |
| -------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| OneSync                          | Yes      | Server-side actions on players, vehicles and entities                                                          |
| `ox_lib`                         | Yes      | Callbacks, keybinds, locales, scheduled cleanup                                                                |
| `oxmysql`                        | Yes      | Ranks, staff, sanctions, transcripts and audit log                                                             |
| `cuxial_bridge`                  | Yes      | Connects to the framework and the inventory; provides the media module used by the screen view                 |
| `qbx_core`                       | Yes      | Framework. QBox is the only one supported                                                                      |
| `cuxial_medical`                 | No       | Revive, heal and kill go through the medical system. Without it the panel uses its own basic versions          |
| `cuxial_appearance`              | No       | Opens the appearance editor. Without it those actions are unavailable                                          |
| `cuxial_garages`                 | No       | Vehicle keys. Without it, spawned vehicles come without keys and "take keys" reports an error                  |
| `cuxial_multichar`               | No       | Tab that reviews minor character requests. Without it the tab stays empty                                      |
| `cuxial_cmservices`              | No       | Community service. Without it those actions fail                                                               |
| `cuxial_emotes`                  | No       | Restores the player's own walk style when the drunk effect ends                                                |
| `av_weather` or `prim_climatime` | No       | The panel hands time, weather and blackout to the weather resource. Without one, the panel applies them itself |
| txAdmin                          | No       | Its bans, kicks and warnings are copied to the sanctions history                                               |

## 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, SQL, first superadmin, convars and start order.</td><td><a href="/scripts/core/cuxial-admin/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code>, the convars and the data files.</td><td><a href="/scripts/core/cuxial-admin/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Commands, keys, ranks and the full permission list.</td><td><a href="/scripts/core/cuxial-admin/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>What other resources can hook into.</td><td><a href="/scripts/core/cuxial-admin/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-admin/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-admin.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.