Create kick.md

LunaHartwood · May 3, 2021 · 5e999a7 · 5e999a7
1 parent f64eb19
commit 5e999a7
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/functions/kick.md b/functions/kick.md
@@ -0,0 +1,17 @@
+# $kick
+Kicks a user from the provided server.
+
+## Usage
+```$kick[guildID;userID;reason]```
+
+### Breakdown
+`guildID` - The server that the user gets kicked from. Use `$guildID` for the current server.
+`userID` - The user who is being kicked.
+`reason` - The reason why the user is getting kicked (for the audit log).
+
+## Example
+```bot.command({
+    type: "command",
+    name: "kick",
+    code: `$kick[$guildID;$mentioned[1];$replaceText[$message;$message[1];;1]]` // kicks the mentioned user.
+})```