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

# Features guide

How Cuxial Gym is used in game: training, stats, memberships, businesses and the staff editors.

What players, business owners and staff do with Cuxial Gym once it is installed.

## Training

A player interacts with a piece of equipment and picks one of its exercises. The character moves into position and the set begins.

1. Each rep asks for a minigame. The minigames and their difficulty range are set per piece of equipment; difficulty climbs from the minimum to the maximum along the set.
2. A passed minigame counts one rep. A failed one ends the set.
3. The set also ends when the player presses <kbd>X</kbd>, reaches the exercise's rep limit, walks away, or tires out the muscle being trained.
4. When the set ends, the reps are turned into XP, fatigue, streak progress and achievements.

Only one player can use a piece of equipment at a time.

### Stats

| Stat     | Trained by                           | Effect                                   |
| -------- | ------------------------------------ | ---------------------------------------- |
| Strength | Chest, shoulders, back, arms and abs | Extra maximum health at set levels       |
| Agility  | Chest, arms, abs, thighs and calves  | Extra stamina regeneration at set levels |

Each body part splits the XP of a rep between both stats with its own weights. Levels, XP curve, bonuses and an optional daily decay are edited in the creator.

### Fatigue

Every rep tires the body parts the exercise works. Above the fatigue limit, a part cannot be trained until it rests. Fatigue recovers by itself over time, at a rate per body part.

### Streaks and achievements

Doing the minimum reps in a day keeps the streak going. Reaching certain streak lengths gives an XP bonus. Achievements track reps, streaks, workouts, supplements, memberships, reps helped, daily rewards, money spent and exercise variety.

### Supplements

Supplements are inventory items. Using one plays a short animation and starts a timed effect:

| Effect            | What it does                                          |
| ----------------- | ----------------------------------------------------- |
| XP bonus          | More XP per rep                                       |
| Fatigue reduction | Less fatigue per rep                                  |
| Minigame chance   | Chance for a rep to pass without playing the minigame |

Effects of several active supplements add up.

## Gym panel

The gym menu point opens the player panel of that gym: condition, stats, active bonuses, streak, the exercise catalogue, leaderboards, achievements and the membership tab. A guided tour runs the first time.

With `tablet.dui = true` the panel is drawn on the screen prop itself and the camera moves in front of it. If there is no screen prop nearby, it opens as a regular full-screen interface.

## Memberships

Each zone has its own membership settings:

* **Required or not.** In a zone that requires a pass, equipment and lockers are for members only.
* **Packages.** Each one has a duration in days and a price.
* **Daily reward.** An item active members can claim once per cooldown.

In a zone with no business, staff set this in the creator. When the zone belongs to a business, the business sets its own packages, the money goes to the business funds and the daily reward is taken from its warehouse stock.

## Interaction points

Points are props, peds or plain coordinates placed by staff. Each one carries one or more actions:

| Action                         | Who can use it                                  | What it does                                                            |
| ------------------------------ | ----------------------------------------------- | ----------------------------------------------------------------------- |
| Gym menu                       | Everyone                                        | Opens the gym panel                                                     |
| Locker                         | Everyone; members only where a pass is required | Personal stash for that zone                                            |
| Cloakroom                      | Everyone                                        | Opens the wardrobe set in `cloakroom.handlers`                          |
| Shop                           | Everyone                                        | Buys the items the business has on sale                                 |
| Call worker                    | Players who are not staff of the business       | Sends a prompt to the staff online; the one who accepts gets a waypoint |
| Business management, Boss menu | Staff of the business                           | Opens the business panel                                                |
| Stash                          | Staff of the business                           | Shared business stash                                                   |
| Boss stash                     | Staff with the *Manage finances* permission     | Restricted stash                                                        |
| Claim bonus                    | Staff of the business                           | Collects the bonus the business has paid them                           |

## Businesses

Staff create a business from `/gymadmin`, name its owner and assign it one or more zones. From there the owner runs it from the business panel.

| Section         | What it holds                                                         |
| --------------- | --------------------------------------------------------------------- |
| Dashboard       | Summary and alerts, such as low stock                                 |
| Company         | Name, logo, colour, tax, level and ownership transfer                 |
| Employees       | Hire nearby players, set grades, fire, worked minutes and reps helped |
| Permissions     | Grades, their hourly wage and what each can do                        |
| Finances        | Funds, deposits, withdrawals, income by source, taxes and bonuses     |
| Warehouse       | Stock, supplier orders and which items are on sale                    |
| Ordered items   | Orders on their way and ready to collect                              |
| Memberships     | Packages and daily reward of the business's zones                     |
| Offline workers | Automatic staff hired per period                                      |
| Progression     | Level, unlocks and missions                                           |

### Grades and pay

A business starts with three grades: owner, manager and employee. Each grade has eight permissions: manage company, employees, permissions, warehouse, finances and workers, pay bonuses, and transfer ownership.

Employees add worked minutes while they are inside the work area of the business. Their bonus is the hourly wage of their grade for the time worked. Once the business pays it, the employee collects it at a claim bonus point.

### Warehouse and shop

The business orders items from the catalogue staff define. An order is paid from the business funds and arrives after a delivery time. Items in stock can be put on sale in the shop; the sale price is the item's own or the warehouse price times a multiplier.

### Levels and missions

Part of every income becomes business XP. Levels unlock more grades, employee slots and warehouse items, faster deliveries, discounts and the automatic workers. Weekly and one-time starter missions give extra XP.

### Offline workers

Four automatic workers can be hired and upgraded: two that raise income and sales, one that restocks and one that collects orders. They are charged per period.

### Spotters

An employee can interact with a player who is training in a zone of their business and help with the exercise. The spotter plays the same minigame; each one they pass gives the player free reps. Reps helped are counted per employee.

## Staff editors

### Zone creator · `/gymcreator`

| Section             | What it does                                                                                                           |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| All zones           | List, create and delete zones                                                                                          |
| Zone editor         | Equipment with its exercises and minigames, interaction points, map props to remove, membership, blip and ped clearing |
| Global models       | Map props that work as equipment anywhere, without a zone                                                              |
| Minigames & presets | Try each minigame and save difficulty presets                                                                          |
| Gym config          | Fatigue, stats, streak, body parts, achievements, exercise values and the tutorial                                     |
| Supplements         | Items, duration and effects                                                                                            |

Equipment and points are placed in the world with a gizmo or by walking to the spot. The editor can teleport you to any piece of equipment or point.

### Business admin · `/gymadmin`

| Section         | What it does                                                                                |
| --------------- | ------------------------------------------------------------------------------------------- |
| All businesses  | Create, delete, edit fields, employees, stock, zones and interaction points                 |
| Global settings | Rules shared by every business and the shop categories                                      |
| Warehouse items | Catalogue businesses can order: price, sale price, category, stock limit and required level |
| Offline workers | Cost, levels and effect of each automatic worker                                            |
| Progression     | XP curve, level milestones and missions                                                     |

{% hint style="info" %}
Whatever is saved from these editors is stored in the database and replaces the matching defaults of the `data/` files.
{% endhint %}


---

# 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/leisure/cuxial-gym/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.
