summaryrefslogtreecommitdiff
path: root/docs/mod/spam.md
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
committerilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
commitecca9314a53b961f49ae57528e30a3a17f5300dc (patch)
treef99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/mod/spam.md
parent21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff)
feat: docs
Diffstat (limited to 'docs/mod/spam.md')
-rw-r--r--docs/mod/spam.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/mod/spam.md b/docs/mod/spam.md
new file mode 100644
index 0000000..55370d3
--- /dev/null
+++ b/docs/mod/spam.md
@@ -0,0 +1,39 @@
+# Spam
+
+
+> It is recommended to give the bot moderator rights in the chat room. This will speed up the sending of messages.
+
+
+The `!spam` command gives users the ability to repeat a given message a certain number of times in a chat room.
+This feature can be useful for highlighting important information.
+
+## Syntax
+`!spam [amount] [message...]`
+
++ `[amount]` (optional) - A number that specified how many times the message should be repeated.\
+If not specified, the default value is 10. The maximum value is 100.
++ `[message...]` - The text of the message to be repeated.
+
+## Usage
+
++ `!spam forsen`
++ `!spam 100 forsen forsen forsen`
+
+## Responses
+
+```
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+forsen forsen forsen
+...
+```
+
+## Error handling
++ [Not enough arguments](/wiki/errors#0)