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

# Commands & permissions

Commands, keys and permissions of Cuxial Gym: staff editors, business grades and who can use each point.

Cuxial Gym has two staff commands and no player commands. Players do everything through equipment, interaction points and keys.

## Commands

| Command                       | Who                                                                 | What it does                                                                                                 |
| ----------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `/gymcreator`                 | Staff with `cuxial_gym.creator` or the framework permission `admin` | Opens the zone creator: zones, equipment, points, minigame presets, gym balance and supplements.             |
| `/gymadmin`                   | Staff with `cuxial_gym.admin` or the framework permission `admin`   | Opens the business admin panel: businesses, employees, zones, points and the rules shared by every business. |
| `/gymaudio [oneshots\|loops]` | Anyone, only in debug mode                                          | Plays every sound of a sound bank to test the audio.                                                         |

{% hint style="info" %}
Both command names can be changed, or set to `false`, in `commands`. `/gymcreator` needs `modules.creator = true`; `/gymadmin` needs `modules.admin = true` and `modules.business = true`. Neither opens while the player is training or spotting.
{% endhint %}

## Keys

Defaults from `keys`. Each player can rebind them in the GTA key settings, under FiveM.

| Key                    | When                  | What it does                                              |
| ---------------------- | --------------------- | --------------------------------------------------------- |
| <kbd>X</kbd>           | Training or spotting  | Leaves the set, or stops helping                          |
| <kbd>Y</kbd>           | A prompt is on screen | Accepts a job offer, a business transfer or a worker call |
| <kbd>N</kbd>           | A prompt is on screen | Declines it                                               |
| <kbd>Right Shift</kbd> | Creator               | Returns to the editor after looking at the world          |

Minigames show the keys they use on screen.

### Placement keys

Used by staff while placing equipment or a point.

| Key                  | What it does        |
| -------------------- | ------------------- |
| Left mouse button    | Grabs the gizmo     |
| <kbd>T</kbd>         | Move mode           |
| <kbd>R</kbd>         | Rotate mode         |
| <kbd>G</kbd>         | Toggles the cursor  |
| <kbd>Left Alt</kbd>  | Snaps to the ground |
| <kbd>Enter</kbd>     | Confirms            |
| <kbd>Backspace</kbd> | Cancels             |

## Staff permissions

| Permission           | Type                 | Grants                   |
| -------------------- | -------------------- | ------------------------ |
| `cuxial_gym.creator` | ACE                  | The zone creator         |
| `cuxial_gym.admin`   | ACE                  | The business admin panel |
| `admin`              | Framework permission | Both                     |

{% code title="server.cfg" %}

```cfg
add_ace group.admin cuxial_gym.admin allow
add_ace group.admin cuxial_gym.creator allow
```

{% endcode %}

The names of the ACEs and of the framework permission are set in `admin`. The server checks the permission again on every staff action, and each one is written to an audit log kept for `admin.auditDays` days.

## Business permissions

Inside a business, what a member can do depends on their grade. The owner always has all eight.

| Permission         | Allows                                                             |
| ------------------ | ------------------------------------------------------------------ |
| Manage company     | Name, logo and colour                                              |
| Manage employees   | Hire, fire and change the grade of employees                       |
| Manage permissions | Create and edit grades and their wage                              |
| Manage warehouse   | Orders, stock and items on sale                                    |
| Manage finances    | Deposits, withdrawals, taxes, memberships and the boss stash       |
| Manage workers     | Hire and upgrade automatic workers                                 |
| Pay bonuses        | Pay employees their bonus                                          |
| Transfer ownership | Hand the business over to another player. Only the owner can do it |

A member can only edit grades below their own.

## Access to interaction points

| Point                                              | Requirement                               |
| -------------------------------------------------- | ----------------------------------------- |
| Gym menu, cloakroom, shop                          | None                                      |
| Equipment, locker                                  | An active pass, in zones that require one |
| Call worker                                        | Not being staff of that business          |
| Business management, boss menu, stash, claim bonus | Being staff of that business              |
| Boss stash                                         | Being staff with *Manage finances*        |


---

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