Files
SkyBot/COMMANDS.md

91 lines
3.5 KiB
Markdown

# SkyBot Commands
All commands are prefixed with your configured prefix (e.g. `sd/`). Arguments in `[brackets]` are optional.
---
## Fun
| Command | Aliases | Description |
|---|---|---|
| `echo <text>` | `say` | Repeat text through the bot. If the command message is deleted, the echoed message is also deleted. |
---
## Info
| Command | Aliases | Description |
|---|---|---|
| `help` | `cmds` | Shows all commands organised by category with an interactive embed |
| `info <planet\|user> [@user]` | — | Shows detailed info about the current planet or a user |
| `ping` | — | Shows the bot's response time |
| `source` | `src` | Link to the bot's source code |
| `uptime` | — | Shows how long the bot has been running |
| `version` | `ver` | Shows the bot version, Valour server version, and Valour SDK version (current and latest) |
---
## Moderation
> Requires the appropriate planet permissions.
| Command | Aliases | Description |
|---|---|---|
| `kick <@member\|id> [reason]` | — | Kicks a member from the planet. Sends them a DM embed before kicking. |
| `ban <@member\|id> [duration] [reason]` | — | Bans a member from the planet. Duration is optional (e.g. `7d`, `2h`, `30m`). Permanent if omitted. |
---
## RP
| Command | Aliases | Description |
|---|---|---|
| `emote <action> [@user]` | `e` | Send an animated RP emote. Target is optional for most actions. |
| `marriage <propose\|status\|divorce\|force> [...]` | `marry` | Marriage system — propose, check status, or divorce. |
### emote actions
`angry`, `baka`, `bite`, `blowkiss`, `blush`, `bonk`, `carry`, `clap`, `cry`, `cuddle`, `dance`, `facepalm`, `happy`, `holdhand`, `hug`, `kiss`, `laugh`, `lurk`, `nom`, `nya`, `pat`, `poke`, `pout`, `punch`, `run`, `shocked`, `sleep`, `smug`, `spin`, `tableflip`, `teehee`, `tickle`, `wave`, `wink`, `yawn`
### marriage subcommands
| Subcommand | Usage | Description |
|---|---|---|
| `propose` | `marriage propose` | Propose to someone (reply to their message or mention them) |
| `status` | `marriage status [@user]` | Check your own or another user's marriage status |
| `divorce` | `marriage divorce` | Begin a divorce (requires `confirm` to finalise) |
| `force` | `marriage force marry @u1 @u2` / `marriage force divorce @user` | Owner only — force marry or divorce users |
---
## Utils
> These commands respond to pending actions created by other commands.
| Command | Aliases | Description |
|---|---|---|
| `accept` | — | Accept a pending action (e.g. a marriage proposal) |
| `decline` | — | Decline a pending action |
| `confirm` | — | Confirm a pending action (e.g. a divorce) |
| `cancel` | — | Cancel a pending action |
---
## Dev
> These commands are only accessible to the bot owner.
| Command | Aliases | Description |
|---|---|---|
| `blacklist <add\|remove> <@user\|userid>` | — | Add or remove a user from the bot blacklist |
| `delete` | — | Deletes a replied-to message. Deletes bot messages directly; requires `ManageMessages` for other members' messages. Reply to a message to use. |
| `planet <join\|leave\|list>` | — | Manage the planets the bot is a member of |
| `react <emoji> [amount]` | — | Add a reaction to a replied-to message a given number of times |
### planet subcommands
| Subcommand | Usage | Description |
|---|---|---|
| `join` | `planet join <id> [invite]` | Join a planet by ID, optionally with an invite code |
| `leave` | `planet leave [id]` | Leave a planet by ID, or the current planet if no ID is given |
| `list` | `planet list` | List all planets the bot is currently a member of |