# Commands

Every slash command your city's bot registers on Discord, with its options, who can use it and where to turn each one on.

Source: https://fivedash.fivex.gg/docs/en/discord/commands

Your city's bot registers slash commands (`/`) in the Discord server picked during setup. Some are for everyone, like `/status` and `/ip`; the rest are for the staff and only work for the roles you allow in the panel. This page lists them all, with every option, who can use it and which panel page controls it.

## Before you start

* The bot must be connected with setup finished. See [Bot](https://fivedash.fivex.gg/docs/en/discord/bot).
* Commands are registered only in the Discord server linked to the bot. In any other server, the bot replies "This bot hasn't been set up for this server yet."
* Command and option names are fixed and always in Portuguese (that's what members type). Descriptions show in the city's language.
* No command name can be changed in the panel. What you control is whether a command is on and which roles can use it.

## Summary

| Command              | What it does                                                          | Who can use it                                              | Module                                                             | Plan |
| -------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------ | ---- |
| `/status`            | Shows whether the server is online and how many players are connected | Everyone                                                    | —                                                                  | All  |
| `/ip`                | Shows how to connect to the server                                    | Everyone                                                    | —                                                                  | All  |
| `/ban`               | Bans a member from the server                                         | `/ban` roles or Administrator                               | [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation) | All  |
| `/unban`             | Lifts someone's ban                                                   | Same as `/ban`                                              | [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation) | All  |
| `/kick`              | Kicks a member from the server (they can rejoin with an invite)       | `/kick` roles or Administrator                              | [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation) | All  |
| `/mute`              | Times a member out (no talking, reacting or joining voice)            | `/mute` roles or Administrator                              | [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation) | All  |
| `/unmute`            | Ends a member's timeout                                               | Same as `/mute`                                             | [Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation) | All  |
| `/liberar`           | Unlocks an ID in the city (whitelist team)                            | /liberar command roles, Administrator or Manage Server      | [Whitelist](https://fivedash.fivex.gg/docs/en/discord/whitelist)   | All  |
| `/remover`           | Takes the whitelist away from an ID or member (whitelist team)        | Same as `/liberar`                                          | [Whitelist](https://fivedash.fivex.gg/docs/en/discord/whitelist)   | All  |
| `/alinhar`           | Summons a member to talk with the staff                               | Summons roles, Administrator or Manage Server               | [Summons](https://fivedash.fivex.gg/docs/en/discord/alignment)     | Pro  |
| `/alinhado`          | Marks a member's summons as done                                      | Same as `/alinhar`                                          | [Summons](https://fivedash.fivex.gg/docs/en/discord/alignment)     | Pro  |
| `/creator adicionar` | Adds a streamer or video creator to the program                       | **Who uses /creator** roles, Administrator or Manage Server | [Creators](https://fivedash.fivex.gg/docs/en/discord/creators)     | Pro  |
| `/creator remover`   | Removes a member's creator access                                     | Same                                                        | [Creators](https://fivedash.fivex.gg/docs/en/discord/creators)     | Pro  |
| `/creator nivel`     | Changes a creator's level                                             | Same                                                        | [Creators](https://fivedash.fivex.gg/docs/en/discord/creators)     | Pro  |

> Every staff command replies privately: only the person who used it sees the reply. `/status` and `/ip` reply in the channel, for everyone to see.

## Public commands

### /status

Shows whether the FiveM server is online, how many players are connected and the maximum slots. When the server has a connect code (cfx.re), the reply has a button to join the city. No options.

### /ip

Shows how to connect to the server, with the address and the connect button when there's a cfx.re code. No options.

Both use the server address saved in the panel and the **Main color** and **Emoji pack** from the [Bot](https://fivedash.fivex.gg/docs/en/discord/bot) page.

## Moderation

On by default. Each one has a **Turn on /ban** switch (and the same for each command) and a **Roles that can use /ban** field in **Discord → Moderation → Settings**, in the **Commands** group. Turning `/ban` off removes `/unban` too; the same goes for `/mute` and `/unmute`. On save, the panel updates the commands on Discord ("Commands updated on Discord").

**Who can use them:** members with one of the picked roles or the Administrator permission in the server. With no roles picked, only members with Administrator. After that, the bot also checks that:

* nobody punishes themselves, the bot itself or the server owner;
* members in **Protected roles** (or on the protected list) can't be punished;
* the caller's highest role sits above the target's highest role (the server owner always passes);
* the bot's role sits above the target;
* `/mute` doesn't work on members with Administrator.

### /ban

| Option             | Type             | Required | What it is                                                                                                                              |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `membro`           | Member           | Yes      | Who gets banned (an ID works too).                                                                                                      |
| `motivo`           | Text (up to 500) | Yes      | Why (goes in the log and the DM).                                                                                                       |
| `prova`            | Attachment       | No       | Screenshot or video as proof.                                                                                                           |
| `prova_2`          | Attachment       | No       | More proof (optional).                                                                                                                  |
| `prova_3`          | Attachment       | No       | More proof (optional).                                                                                                                  |
| `apagar_mensagens` | Choice           | No       | Delete the member's recent messages: **Don't delete**, **Last hour**, **Last 6 hours**, **Last day**, **Last 3 days**, **Last 7 days**. |

### /unban

| Option    | Type             | Required | What it is                        |
| --------- | ---------------- | -------- | --------------------------------- |
| `usuario` | Member           | Yes      | Who gets unbanned (paste the ID). |
| `motivo`  | Text (up to 500) | No       | Why (goes in the log).            |

### /kick

| Option                        | Type             | Required | What it is                        |
| ----------------------------- | ---------------- | -------- | --------------------------------- |
| `membro`                      | Member           | Yes      | Who gets kicked.                  |
| `motivo`                      | Text (up to 500) | Yes      | Why (goes in the log and the DM). |
| `prova`, `prova_2`, `prova_3` | Attachment       | No       | Up to 3 proof files.              |

### /mute

| Option                        | Type             | Required | What it is                                                                                                                                |
| ----------------------------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `membro`                      | Member           | Yes      | Who gets timed out.                                                                                                                       |
| `duracao`                     | Choice           | Yes      | For how long: 1 minute, 5 minutes, 10 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day, 3 days, 1 week, 2 weeks or 28 days. |
| `motivo`                      | Text (up to 500) | Yes      | Why (goes in the log and the DM).                                                                                                         |
| `prova`, `prova_2`, `prova_3` | Attachment       | No       | Up to 3 proof files.                                                                                                                      |

### /unmute

| Option   | Type             | Required | What it is             |
| -------- | ---------------- | -------- | ---------------------- |
| `membro` | Member           | Yes      | Whose timeout ends.    |
| `motivo` | Text (up to 500) | No       | Why (goes in the log). |

## Whitelist

`/liberar` and `/remover` are always registered, but they only work once the whitelist is set up. Roles are set in **Discord → Whitelist**, in the **/liberar command** block, field **Roles that can use /liberar**.

**Who can use them:** members with one of those roles, Administrator or the Manage Server permission. With no roles picked, only administrators and server managers.

### /liberar

| Option   | Type            | Required | What it is                                                                      |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| `id`     | Text (up to 12) | No       | The game ID (or token); where unlocks go through Discord, the member is enough. |
| `membro` | Member          | No       | Who gets the unlocked role.                                                     |

With `membro`, the bot also gives the unlocked role and takes the whitelist back if the person leaves the Discord.

### /remover

| Option   | Type            | Required | What it is                                     |
| -------- | --------------- | -------- | ---------------------------------------------- |
| `id`     | Text (up to 12) | No       | The game ID (or token).                        |
| `membro` | Member          | No       | Who loses the whitelist and the unlocked role. |

Fill in at least one of the two.

## Summons

Available from the **Pro** plan up. Summons start off: turn them on in **Discord → Summons** (**Turn on summons**). While off, the bot replies "Summons are turned off in the panel." Roles go in **Roles that can use /alinhar**; the default deadline in **Default deadline** (2 hours unless you change it).

**Who can use them:** members with one of those roles, Administrator or Manage Server. With no roles picked, only administrators and server managers. Members in **Roles protected from summons** can't be summoned.

### /alinhar

| Option   | Type             | Required | What it is                                                                                                                                                                                 |
| -------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `membro` | Member           | Yes      | Who gets summoned.                                                                                                                                                                         |
| `motivo` | Text (up to 500) | No       | Why (optional, goes in the notice and the DM).                                                                                                                                             |
| `prazo`  | Choice           | No       | How long the member has to show up: 15 minutes, 30 minutes, 1 hour, 2 hours, 3 hours, 6 hours, 12 hours, 1 day, 2 days, 3 days or 7 days. Unset, the panel's **Default deadline** applies. |

### /alinhado

| Option   | Type   | Required | What it is                             |
| -------- | ------ | -------- | -------------------------------------- |
| `membro` | Member | Yes      | Who has already talked with the staff. |

## Creators

Available from the **Pro** plan up. While the program is off, the bot replies "The creator program is turned off in the panel." Roles go in **Discord → Creators**, field **Who uses /creator**.

**Who can use it:** members with one of those roles, Administrator or Manage Server. With no roles picked, only administrators and server managers.

`/creator` has three subcommands. The `nivel` option suggests the levels created in the panel as you type.

### /creator adicionar

| Option   | Type                    | Required | What it is                                  |
| -------- | ----------------------- | -------- | ------------------------------------------- |
| `membro` | Member                  | Yes      | Who joins the program.                      |
| `nivel`  | Text (with suggestions) | No       | The creator's level (unset, the first one). |
| `canal`  | Text (up to 300)        | No       | Channel link (Twitch, YouTube, TikTok…).    |

### /creator remover

| Option   | Type             | Required | What it is              |
| -------- | ---------------- | -------- | ----------------------- |
| `membro` | Member           | Yes      | Who leaves the program. |
| `motivo` | Text (up to 500) | No       | Why (goes in the DM).   |

### /creator nivel

| Option   | Type                    | Required | What it is           |
| -------- | ----------------------- | -------- | -------------------- |
| `membro` | Member                  | Yes      | The creator.         |
| `nivel`  | Text (with suggestions) | Yes      | The creator's level. |

## When commands change

* The bot registers its commands when setup finishes and checks them again on every **Check connection** on the overview.
* Turning `/ban`, `/kick` or `/mute` on or off in **Moderation** adds or removes the commands on Discord when you save. If Discord doesn't respond, the panel shows "Saved, but the commands didn't change on Discord"; open the bot's overview and click **Check connection**.
* When FiveDash updates its commands, every bot gets the new version on its own.
* If you see "This command no longer exists. It will disappear from Discord shortly.", Discord is still showing an old command. It goes away on its own shortly.

## FAQ

**A moderator used /ban and got "You don't have one of the roles that can use /ban". What now?**
Add their role in **Discord → Moderation → Settings**, in **Roles that can use /ban**, and save.

**The commands don't show up on Discord.**
Open **Discord → Overview** and click **Check connection**. If the commands row fails, use **Add again** to authorize the bot once more with the commands permission.

**Why do `/alinhar` and `/creator` show up if my plan is Plus?**
They're registered on every bot, but they only work with the module on, and Summons and Creators open from the Pro plan up.

## Next steps

[Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation)Turn on /ban, /kick and /mute and pick the roles.
[Whitelist](https://fivedash.fivex.gg/docs/en/discord/whitelist)Set up unlocks and /liberar.
[Summons](https://fivedash.fivex.gg/docs/en/discord/alignment)Call members in to talk, with a deadline.
[Creators](https://fivedash.fivex.gg/docs/en/discord/creators)Build your city's creator program.
