From ecca9314a53b961f49ae57528e30a3a17f5300dc Mon Sep 17 00:00:00 2001
From: ilotterytea <iltsu@alright.party>
Date: Sun, 19 May 2024 00:16:04 +0500
Subject: feat: docs

---
 docs/mod/mass-ping.md | 30 ++++++++++++++++++++++++++++++
 docs/mod/spam.md      | 39 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+)
 create mode 100644 docs/mod/mass-ping.md
 create mode 100644 docs/mod/spam.md

(limited to 'docs/mod')

diff --git a/docs/mod/mass-ping.md b/docs/mod/mass-ping.md
new file mode 100644
index 0000000..133fe87
--- /dev/null
+++ b/docs/mod/mass-ping.md
@@ -0,0 +1,30 @@
+# Mass ping
+
+
+> To use the `!massping` command, you must assign moderator to the bot.
+> Following the Twitch API docs, only moderators have access to full chatter list.
+
+
+The `!massping` command gives the ability to mass mentioning (mass ping) chatters.
+This feature allows you to quickly and efficiently draw the attention of a large number of users to a certain message.
+
+## Syntax
+`!massping [message...]`
+
++ `[message...]` (optional) - A text message that will be sent along with a mention of all chatters.
+
+## Usage
+
++ `!massping forsen`
++ `!massping good morning everyone!! have a nice day :3`
++ `!massping`
+
+## Responses
+
++ `@chatter1, @chatter2, @chatter3, ..., forsen`
++ `@chatter1, @chatter2, @chatter3, ..., good morning everyone!! have a nice day :3`
++ `@chatter1, @chatter2, @chatter3, ...,`
+
+## Error handling
+
++ [Insufficient rights](/wiki/errors#3)
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)
-- 
cgit v1.2.3