> 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/features.md).

# Features guide

How Cuxial Gang is used in game: staff panel, boss menu, tablet, territory and activities.

What each part of Cuxial Gang does in game and who uses it. Option names in `code` point to [Configuration](/scripts/gangs/cuxial-gang/configuration.md).

## Roles

| Role   | How you get it                                      | What it gives                                                     |
| ------ | --------------------------------------------------- | ----------------------------------------------------------------- |
| Staff  | The ACE in `admin.ace`                              | The staff panel and the staff commands                            |
| Boss   | Top rank of an organization                         | Everything in the boss menu                                       |
| Member | Invited from the boss menu, or added by staff       | Tablet, headquarters points allowed by the rank, interaction menu |
| Mule   | Recruited by an organization with the mules network | A mule view of the tablet with contracts to take                  |

## Staff panel

Opened with `/crimeadmin`. Everything edited here is saved in the database and applied without a restart.

| Section                  | What you manage                                                                                                                              |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Organizations            | Create, edit and delete organizations: name, type (gang or cartel), colour, headquarters points, extra stashes, money, upgrades and vehicles |
| Garages, Ports, Helipads | Shared locations where organizations take out land, water and air vehicles                                                                   |
| Clandestine medic        | Locations of the medic NPC                                                                                                                   |
| Vehicle store            | Catalogue of vehicles an organization can buy, their price and which organizations may buy them                                              |
| Upgrades                 | Price of each upgrade                                                                                                                        |
| Season pass              | Rewards per level, price of the premium track and end date; reset of organization levels                                                     |
| Turf zones               | Draw, edit and delete turf polygons on the map                                                                                               |
| Racketeering             | Collection points and their payout                                                                                                           |
| Favelas                  | Polygons, crafting recipes, manual assignment and history                                                                                    |
| Airdrops                 | Landing sites, loot per tier, manual launch, cancel and history                                                                              |
| History                  | Log of staff actions                                                                                                                         |

Points and polygons are placed in the world with a free camera. While you place them the panel hides; <kbd>Right Shift</kbd> brings back a minimized panel.

## Organizations

An organization has a type, a colour, a level with experience, two accounts (clean balance and dirty money), ranks, members and a headquarters.

* **Gang** is the default type.
* **Cartel** adds two things: a helipad at its own headquarters and supply points in the zones it controls.

A new organization starts with `org.defaultSlots` ranks and members, and grows with upgrades up to `org.ranksLimit` and `org.membersLimit`.

### Headquarters points

Each point is a marker in the world. A member sees and uses it only when the rank allows it.

| Point                   | Rank permission                                        | Notes                                                                                |
| ----------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| Boss menu               | Boss menu access                                       |                                                                                      |
| Stash and extra stashes | Storage access                                         | Capacity grows with the stash upgrade                                                |
| Cloakroom               | Any member to wear, boss menu access to save or delete | Needs `cuxial_appearance`, or `tgiann-clothing` when selected in `data/clothing.lua` |
| Garage                  | Garage access                                          | The shared garages need the garage upgrade                                           |
| Port                    | Port access                                            | Needs the port upgrade                                                               |
| Helipad                 | None                                                   | Cartels only, needs the helipad upgrade                                              |
| Clandestine medic       | Clandestine medic access                               | Needs the upgrade and `cuxial_medical`                                               |
| Money laundering        | Money laundering access                                | Needs the upgrade                                                                    |

## Boss menu

| Section     | What the boss does                                                                                                                                   |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Summary     | Level, experience, members online, money and current missions                                                                                        |
| Members     | Invite a nearby player, change a rank, fire, read a member's history                                                                                 |
| Ranks       | Create, rename, reorder and delete ranks, and tick the permissions of each one                                                                       |
| Finances    | Clean and dirty money, with income and expenses                                                                                                      |
| Upgrades    | Buy slots (vehicles, outfits, members, ranks, mules) and unlock services (garage, port, helipad, clandestine medic, money laundering, mules network) |
| Vehicles    | Buy from the catalogue and sell back, losing `garage.sellPercentage`                                                                                 |
| Season pass | Unlock the premium track and claim the reward of each level                                                                                          |
| Arsenal     | Arsenal level, recipes unlocked and weekly quota                                                                                                     |
| Mules       | Recruit, write contracts, follow them and dismiss a mule                                                                                             |
| Activity    | Recent actions of the organization                                                                                                                   |

Upgrades are paid from the clean balance, or from dirty money with `org.useDirtyMoneyInBossMenu = true`. The premium season pass is always paid from the clean balance.

## Tablet

Opened with `/crimetablet`, or with the item when `tablet.asItem = true`.

| Tab         | Content                                                                                                      |
| ----------- | ------------------------------------------------------------------------------------------------------------ |
| Ranking     | Organizations ordered by points: captured zones, missions done, level, loyalty, controlled zones and favelas |
| Map         | Zones, turf and their owners                                                                                 |
| Dark chat   | Chat shared by the members of all organizations                                                              |
| Season pass | Progress and rewards                                                                                         |
| Missions    | Missions available until the next restart                                                                    |
| Mules       | Contracts, for a mule                                                                                        |

Ranking, dark chat and season pass can be hidden one by one in the `tablet` block.

### Missions

On each restart the server draws `tablet.missionsPerRestart` missions from `data/missions.lua`. A member starts one from the tablet. The server checks the minimum time, the delivery place and the items before paying. The reward goes to the stash, the balance, the dirty money or the garage depending on its type.

## Territory

### Capture zones

Fixed polygons listed in `zones.list`. The organization with members inside captures the zone over time and earns `zones.captureExp`. A captured zone cannot be contested again for `zones.cooldownMinutes`.

### Turf zones

Polygons drawn in the staff panel. Each organization gathers loyalty in a zone by selling drugs and painting graffiti there.

With `turf.control.enabled = true`, the owner is decided by sales inside a moving window of `windowDays` days:

| Level | State    | When                                                                                                 |
| ----- | -------- | ---------------------------------------------------------------------------------------------------- |
| 0     | Calm     | The owner has no real competition                                                                    |
| 1     | Disputed | A rival reaches `disputedUnits` units                                                                |
| 2     | Hot      | The rival reaches `hotRatio` of what the owner sells. More police alerts and more buyers backing out |
| 3     | War      | The rival sells more than the owner by `takeoverMargin`. A war opens for `warHours` hours            |

A zone with no owner goes to the first organization that sells `claimUnits` units. A zone nobody sells in for `abandonDays` days loses its owner.

An organization can also pay `turf.rivalry.startPrice` to declare a war on a zone. The winner earns `turf.rivalry.winExp`.

### Selling drugs

A player uses the burner phone anywhere on the map. A buyer walks up and asks for a few units of a drug the player carries. Price comes from `data/drugselling.lua` and changes with the zone: own zone, enemy zone, disputed zone and own graffiti nearby each have a multiplier in `turf.sales`.

Selling in someone else's zone warns the owner, more precisely the more the seller insists, and pays the owner a share as dirty money (`turf.sales.taxPercent`). A sale may reach the police through `cuxial_police`, and a buyer may refuse and attack.

### Graffiti

A member uses the spray can on a wall, chooses the size and paints the image of the organization. A graffiti gives loyalty in its turf zone and a price bonus to sales around it. It lasts `lifetimeHours`, is protected from rivals for `protectionMinutes`, and falls after `enemySalesToRemove` enemy sales in its radius. The remover erases a graffiti.

### Racketeering

Staff create collection points with a payout. A member collects a point every `cooldown` minutes, set in `data/racketeering.lua`.

### Cartel supply points

A cartel leaves drugs in a physical stash inside a zone it owns. The zone then sells on its own every `tickMinutes` while stock remains and the owner has members online. Rivals can rob the point and the police can seize it.

### Favelas

Polygons created by staff. An organization takes a favela by keeping `minInside` members inside through a warning bar and then a capture bar. If another organization enters with enough members meanwhile, the bars stop and it becomes a fight: the one that holds wins. The prize is a crafting bench only the owner can use, with the recipes staff set for that favela. It needs `nextgenfivem_crafting`. Ownership is protected for `ownershipHours`.

### Airdrops

Every `timerHours` hours a crate falls at one of the sites. The phases are: a wide signal on the map, the fall with NPC guards, capture by the organization that stays alone inside the radius for the time of the tier, and, in the higher tiers, extraction of the crates by vehicle to the headquarters.

There are four tiers: bronze, silver, gold and diamond. Sites and loot are seeded from `data/airdrop.lua` the first time and edited afterwards in the staff panel.

## Mules

An organization with the mules network upgrade recruits nearby players as mules. The boss writes a contract with a payment; the mule accepts it from the tablet and completes its steps at the marked points, or with `/mulapaso`. Finished contracts raise the mule's trust; failed ones lower it.

## Interaction menu and hostages

A member presses <kbd>F6</kbd> next to another player to open the interaction menu: handcuff, escort, search, put a bag over the head, put into a vehicle or take out of it. The server checks the distance again on every action.

Aiming a weapon at an NPC hostage opens its own menu: hands up, kneel, follow, get into the vehicle or release.

## Phone activities

With `lb-phone` and the companion phone app, members get three more activities by chat: extorting civilians, buying hostages from intermediaries, and ordering arsenal parts from a dealer. Mules also receive their notifications and mail on the phone.

## Arsenal

With `nextgenfivem_crafting`, an organization crafts weapons at arsenal benches placed by staff. The arsenal level depends on the units the organization has sold. Each level unlocks recipes, sets a weekly quota and hands a blueprint to the stash. A bench close to a headquarters belongs to that organization; one far from any headquarters is neutral.

## Police raids

Disabled by default in `data/raids.lua`. When enabled, a job in `allowedJobs` starts a raid on a headquarters with `/startraid`. During the raid, officers can open the stash, take clean and dirty money and impound stored vehicles, within the limits of the file.


---

# 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/features.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.
