diff --git a/COMMANDS.md b/COMMANDS.md new file mode 100644 index 0000000..0a480c2 --- /dev/null +++ b/COMMANDS.md @@ -0,0 +1,100 @@ +# SkyBot Commands + +All commands are prefixed with your configured prefix (e.g. `s/`). Arguments in `[brackets]` are optional. + +--- + +## Fun + +| Command | Aliases | Description | +|---|---|---| +| `8ball [question]` | — | Ask the magic 8 ball a question | +| `cat` | — | Post a random cat picture | +| `choose ` | — | Pick one of the given options | +| `coinflip` | — | Flip a coin | +| `dice` | — | Roll a die | +| `echo ` | — | Repeat text through the bot | +| `hangman [category]` | — | Start a channel-wide game of hangman (`hg ` to guess) | +| `image ` | `img` | Fetch a random image matching your search | +| `mock` | — | mOcK tExT of a message (reply to one) | +| `reverse` | — | Reverse a message (reply to one or pass text) | +| `rockpaperscissors` | `rps` | Play rock paper scissors against the bot | +| `t9encode ` | — | Encode text into old phone keypad multi-tap digits | +| `t9decode ` | — | Decode old phone keypad multi-tap digits | +| `trivia` | — | Start a channel-wide trivia question with 30 seconds to answer (`tg ` to guess) | +| `wordle` | — | Start a channel-wide Wordle; guess the 5-letter word in 6 tries (`wg ` to guess) | + +--- + +## Info + +| Command | Aliases | Description | +|---|---|---| +| `botguide` | `bot`, `bguide` | Link to the Valour bot guide | +| `devcentral` | — | Invite link to the Dev Central planet | +| `info` | — | User and planet info | +| `joinsite` | — | Link to a site to help bots join a planet | +| `minecraft` | — | Unofficial ValourSMP server IPs | +| `ping` | — | Check bot latency | +| `source` | — | Link to the bot's source code | +| `suggest ` | — | Submit a suggestion for the bot | +| `swagger` | — | Link to the Valour API docs | +| `uptime` | — | Show how long the bot has been running | +| `usercount` | — | Show the total Valour user count | +| `version` | — | Show the current bot and Valour SDK version | + +--- + +## Moderation + +| Command | Aliases | Description | +|---|---|---| +| `ban <@user> [reason]` | — | Ban a member from the planet | +| `bans` | — | List all bans in the planet | +| `kick <@user> [reason]` | — | Kick a member from the planet | +| `setwelcome` | — | Configure a welcome channel and message | +| `unban ` | — | Unban a member from the planet | + +--- + +## RP + +All RP commands accept an optional `[@user]` argument or a message reply to target someone. + +| Command | Description | +|---|---| +| `angry` | Express anger | +| `baka` | Call someone a baka | +| `bite` | Bite someone | +| `blowkiss` | Blow a kiss | +| `blush` | Blush | +| `bonk` | Bonk someone | +| `carry` | Carry someone | +| `clap` | Clap | +| `cry` | Cry | +| `cuddle` | Cuddle someone | +| `dance` | Dance | +| `facepalm` | Facepalm | +| `happy` | Express happiness | +| `holdhand` | Hold hands with someone | +| `hug` | Hug someone | +| `kiss` | Kiss someone | +| `laugh` | Laugh | +| `lurk` | Lurk | +| `nom` | Nom someone | +| `nya` | Nya | +| `pat` | Pat someone | +| `poke` | Poke someone | +| `pout` | Pout | +| `punch` | Punch someone | +| `run` | Run | +| `shocked` | Act shocked | +| `sleep` | Sleep | +| `smug` | Be smug | +| `spin` | Spin | +| `tableflip` | Flip a table | +| `teehee` | Teehee | +| `tickle` | Tickle someone | +| `wave` | Wave | +| `wink` | Wink | +| `yawn` | Yawn | diff --git a/PRIVACY.md b/PRIVACY.md index 81bf1e3..335e96a 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -60,7 +60,7 @@ Some features make outbound requests to third-party APIs to fetch content. These - **Datamuse** (datamuse.com) — word lists for Hangman and Wordle - **Open Trivia Database** (opentdb.com) — trivia questions for Trivia - **The Cat API** (thecatapi.com) — random cat images for the cat command -- **nekos.best** (nekos.best) — hug GIFs for the hug command +- **nekos.best** (nekos.best) — GIFs for all RP commands (hug, pat, kiss, dance, etc.) - **Pixabay** (pixabay.com) — images for the image command --- diff --git a/README.md b/README.md index 1f7ce63..cbb9936 100644 --- a/README.md +++ b/README.md @@ -11,46 +11,14 @@ SkyBot is a Valour.gg bot built with .NET 10. - Built with .NET 10 - Command system with automatic registration -### Fun +### Command Categories -- `8ball` — ask the magic 8 ball a question -- `coinflip` — flip a coin -- `dice` — roll a die -- `rockpaperscissors` — play rock paper scissors against the bot -- `choose` — pick one of the given options -- `echo` — repeat text through the bot -- `reverse` — reverse yours or a replied message -- `mock` — mOcK tExT -- `t9encode` / `t9decode` — encode or decode old phone keypad multi-tap digits -- `hangman` — channel-wide game of hangman with optional category (`hg ` to guess) -- `wordle` — channel-wide Wordle; guess the 5-letter word in 6 tries (`wg ` to guess) -- `trivia` — channel-wide trivia question with 30 seconds to answer (`tg ` to guess) -- `image` — fetch a random image matching your search (aliases: `img`) +- **Fun** — games, utilities, and silly stuff (8ball, hangman, wordle, trivia, and more) +- **Info** — bot and platform info commands +- **Moderation** — ban, kick, welcome messages +- **RP** — roleplay GIF commands powered by nekos.best (35+ commands) -### Chill - -- `cat` — post a random cat picture -- `hug` — send a hug with a random gif - -### Info - -- `ping` — check bot latency -- `uptime` — show how long the bot has been running -- `info` — user and planet info -- `version` — show the current bot and Valour SDK version -- `usercount` — show the total Valour user count -- `source` — link to the bot's source code -- `joinsite` — link to a site to help bots join a planet -- `devcentral` — invite link to the Dev Central planet -- `swagger` — link to the Valour API docs -- `minecraft` — Unofficial ValourSMP server IPs -- `suggest` — submit a suggestion for the bot - -### Moderation - -- `ban` / `unban` / `kick` — member moderation -- `bans` — list all bans in the planet -- `setwelcome` — configure a welcome channel and message +Full command list: [COMMANDS.md](COMMANDS.md) --- @@ -126,4 +94,4 @@ Never commit your `.env` file to the repository. Ensure it is listed in your `.g ## Running the Bot ```bash dotnet run -``` \ No newline at end of file +```