> 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/gangs/cuxial-gang-app.md).

# Cuxial Gang App

Phone app for Cuxial Gang: organization, chat, mules, contacts and turf map inside lb-phone.

Cuxial Gang App puts Cuxial Gang on the phone. Members follow their organization, talk in its chat and check the turf map without opening the tablet, and every player gets an escort booking service in the same app.

{% hint style="warning" %}
Cuxial Gang App is a companion, not a standalone script. It requires **QBox** (`qbx_core`), **lb-phone** as the phone and **Cuxial Gang** running.
{% endhint %}

## What it does

The app shows a different home screen depending on who opens it. The role comes from Cuxial Gang.

| Who opens it                                       | What they see                                                                                                     |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Member of an organization                          | **Mi Banda**, the gang screen (home, chat, mules, contacts, zones), plus the escort service and the contact book. |
| Active mule                                        | **Trabajos**, the jobs screen (home, contracts, contacts), plus the escort service.                               |
| Police (`police`, `sheriff`, `lspd` or `bcso` job) | The escort service only.                                                                                          |
| Anyone else                                        | The escort service and the contact book.                                                                          |

* **Home.** Balance, dirty money, level, members online, zones owned, vehicles and recent activity of the organization.
* **Chat.** The organization chat of Cuxial Gang, with phone notifications.
* **Mules.** Bosses see their mules and contracts, send an offer to a nearby player and dismiss a mule. Mules see and accept contracts.
* **Contacts.** Conversations with the contacts of Cuxial Gang. A player can send the location of their GPS waypoint.
* **Zones.** Map with the turfs and who controls each one.
* **Escort service.** The player creates a profile, books a companion, picks her up by car at a meeting point and plays the booked services inside the vehicle. Prices, meeting points and profiles are set in `data/kokka.lua`.

## Requirements

| Resource       | Required | Used for                                                                        |
| -------------- | -------- | ------------------------------------------------------------------------------- |
| `qbx_core`     | Yes      | Player data and payments. The only supported framework.                         |
| `lb-phone`     | Yes      | The phone that hosts the app. The only supported phone.                         |
| `cuxial_gang`  | Yes      | Roles, organization data, chat, mules, contacts and zones.                      |
| `ox_lib`       | Yes      | Callbacks, commands, notifications and locales.                                 |
| `oxmysql`      | Yes      | Escort service accounts.                                                        |
| `ox_inventory` | No       | Only with `DirtyPayout = true`, to charge bookings with the `black_money` item. |

## 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 and start order.</td><td><a href="/scripts/gangs/cuxial-gang-app/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>The app entry in the phone and the escort service.</td><td><a href="/scripts/gangs/cuxial-gang-app/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Staff commands and in-game keys.</td><td><a href="/scripts/gangs/cuxial-gang-app/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>The one export other resources can call.</td><td><a href="/scripts/gangs/cuxial-gang-app/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/gangs/cuxial-gang-app/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/gangs/cuxial-gang-app.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.