Skip to content

Commit ffde4d1

Browse files
committed
docs: Add slash documentation
1 parent d5a8e6c commit ffde4d1

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ maxdepth: 1
1717
---
1818
Installation <usage/installation>
1919
Settings <usage/configuration>
20+
Slash Commands <usage/slash_commands>
2021
```
2122

2223
```{toctree}

docs/usage/slash_commands.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Slash Commands
2+
3+
QChat supports Discord-style slash commands. Type a command starting with `/` in the chat input to use it.
4+
5+
## Available Commands
6+
7+
| Command | Description | Example |
8+
| :------ | :---------- | :------ |
9+
| `/list` | Display all available commands | `/list` |
10+
| `/shrug` | Send the shrug emoticon ¯\\_(ツ)_| `/shrug oh well` |
11+
| `/tableflip` | Send the table flip emoticon (╯°□°)╯︵ ┻━┻ | `/tableflip QGIS crash` |
12+
| `/lenny` | Send the Lenny face ( ͡° ͜ʖ ͡°) | `/lenny` |
13+
| `/yolo` | Convert your message to UPPERCASE with a dice emoji | `/yolo let's do this` |
14+
| `/flip` | Flip a coin (heads or tails) | `/flip` |
15+
| `/roll` | Roll dice with customizable faces and count | `/roll 2d20` |
16+
| `/8ball` | Ask the magic 8-ball a question | `/8ball Will it rain?` |
17+
18+
## Command Details
19+
20+
### /list
21+
22+
Displays a list of all available slash commands with their descriptions.
23+
24+
### /shrug, /tableflip, /lenny
25+
26+
These emoticon commands send their respective text art to the chat. You can optionally add a message after the command:
27+
28+
```
29+
/shrug I don't know
30+
```
31+
32+
Sends: `¯\_(ツ)_/¯ I don't know`
33+
34+
### /yolo
35+
36+
Converts your message to uppercase and adds a dice emoji. If no message is provided, sends "YOLO! 🎲".
37+
38+
```
39+
/yolo let's go
40+
```
41+
42+
Sends: `LET'S GO 🎲`
43+
44+
### /flip
45+
46+
Flips a virtual coin and returns either "Heads" or "Tails" with a coin emoji.
47+
48+
### /roll
49+
50+
Rolls dice with customizable parameters. Supports several formats:
51+
52+
- `/roll` — Roll a single 6-sided die (default)
53+
- `/roll 20` — Roll a single 20-sided die
54+
- `/roll 2d6` — Roll 2 six-sided dice
55+
- `/roll 4d20` — Roll 4 twenty-sided dice
56+
57+
**Limits:**
58+
59+
- Number of dice: 1 to 100
60+
- Number of sides: 2 to 1000
61+
62+
When rolling multiple dice, the result shows each individual roll and the total:
63+
64+
```
65+
🎲 15, 8, 12 (total: 35)
66+
```
67+
68+
### /8ball
69+
70+
Ask the [magic 8-ball](https://en.wikipedia.org/wiki/Magic_8_Ball) a question and receive a random classic response. The question text is optional but makes it more fun:
71+
72+
```
73+
/8ball Should I use Shapefile?
74+
```
75+
76+
Possible responses include:
77+
78+
- Positive: "It is certain", "Without a doubt", "Yes definitely", "Outlook good"
79+
- Neutral: "Reply hazy, try again", "Ask again later", "Cannot predict now"
80+
- Negative: "Don't count on it", "My reply is no", "Outlook not so good", "Very doubtful"
81+
82+
## Autocomplete
83+
84+
When you start typing `/` in the chat input, QChat provides autocomplete suggestions for available commands.

0 commit comments

Comments
 (0)