diff --git a/functions/kick.md b/functions/kick.md new file mode 100644 index 0000000..e562dca --- /dev/null +++ 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. +})```