> 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/interface/cuxial-chat/commands.md). # Commands & permissions Commands, keys and player settings of Cuxial Chat, and who can use each one. Every command of Cuxial Chat is open to all players. There are no staff commands. ## Commands | Command | Who | What it does | | ----------------- | ---------------------------------- | ---------------------------------------------------------------------------------------- | | `/me ` | Everyone | Describes an action of your character. Nearby players see it. | | `/do ` | Everyone | Describes the scene. Nearby players see it. | | `/ic ` | Everyone | Speaks out loud to nearby players. | | `/ooc ` | Everyone | Out of character message to nearby players. | | `/pm ` | Everyone | Private message to the player with that server id. | | `/dice [faces]` | Everyone | Rolls a die and shows the result to nearby players. 12 faces if omitted; from 2 to 1000. | | `/gchat ` | Members of an organization, police | Message to all organizations. The police do not read it. | | `/gchatp ` | Members of an organization, police | Same as `/gchat`, but the police read it too. | | `/img ` | Everyone | Shares an image with nearby players. Only when `images.enabled = true`. | | `/clear` | Everyone | Clears your own chat. | {% hint style="info" %} `` is required and `[faces]` is optional. "Nearby" is the `proximity` radius of the config, 12 metres by default. The names of `/gchat`, `/gchatp` and `/img` can be changed in `shared/config.lua`. {% endhint %} ### Organization channel * A player belongs to an organization when they have a gang. * `/gchat` reaches every player in an organization. Police do not see it. * `/gchatp` also reaches the police. The message is tagged as open. * Police are the jobs in `gchat.policeJobs`. With `gchat.requireDuty = true` they must be on duty to read and write. * Whatever the police write is always public, with either command. Set `gchat.policeCanWrite = false` to make it read only for them. ## Keys | Key | What it does | | ----------------------------------- | --------------------------------------------------------------------------------------------- | | T | Opens the chat. Default from `ui.openKey`; each player can rebind it in the GTA key settings. | | Enter | Sends and closes. | | Shift + Enter | Sends without closing. | | Tab | Completes the suggestion or switches channel. | | ↑ ↓ | Message history, or moves through the suggestion list. | | Esc | Closes the open panel or the chat. | ## Writing | You type | What happens | | ------------ | ----------------------------------------------------------- | | `/command` | Opens the command palette with fuzzy search. | | `@name` | Mentions a nearby player. They get a highlight and a sound. | | `:word` | Searches an emoji by word. | | `*text*` | Bold. | | `_text_` | Italic. | | `` `text` `` | Monospace. | Text sent without a command goes to the channel of the open tab: IC, OOC, ME, DO or the organization channel. In the general view it goes to IC. Private messages always need `/pm`. ## Player settings Each player opens the settings panel from the chat. Changes apply instantly, and a button resets everything. | Setting | Values | | -------------------------- | ------------------------------------------------------------------------ | | Position | Eight anchors around the screen | | Scale | 75 % to 140 % | | Width and height | Sliders | | Opacity | 25 % to 100 % | | Density | Cozy or compact | | Time | Hidden, clock or relative | | Group consecutive messages | On or off | | Idle background | Glass, veil or clean | | Fade messages out | Never, or up to 120 seconds | | Sounds | Interface sounds on or off, mention sound on or off, typing sound volume | | `/me`, `/do` and rolls | Both, head only or chat only | | Bubble size | 80 % to 150 % | | Channels | Mute or unmute each channel | A mention still gets through a muted channel. ## Permissions Cuxial Chat adds no ACE permissions. Access depends only on the player's situation: | Feature | Requirement | | ------------------- | --------------------------------------------------------------------------------------------------------------- | | `/gchat`, `/gchatp` | Belong to an organization, or have a job listed in `gchat.policeJobs` (on duty with `gchat.requireDuty = true`) | | Anonymous name | Wear a mask, in the channels enabled in `anonymous.channels` | --- # 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/interface/cuxial-chat/commands.md?ask=&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.