From 024db69f4741503132da643602408e5084e30c39 Mon Sep 17 00:00:00 2001 From: Adeithe <28549467+Adeithe@users.noreply.github.com> Date: Fri, 3 May 2024 11:37:47 -0400 Subject: [PATCH 1/2] Add documentation for votekick module --- docs/chatbot/commands/default/votekick.md | 29 +++++++++++++++++++ docs/chatbot/modules/votekick.md | 34 +++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 docs/chatbot/commands/default/votekick.md create mode 100644 docs/chatbot/modules/votekick.md diff --git a/docs/chatbot/commands/default/votekick.md b/docs/chatbot/commands/default/votekick.md new file mode 100644 index 0000000..d506b1d --- /dev/null +++ b/docs/chatbot/commands/default/votekick.md @@ -0,0 +1,29 @@ +--- +id: votekick +tags: + - chatbot + - commands + - votekick +description: Begins a tribunal for chat to decide if a user should be kicked from the chat +keywords: + - streamelements votekick command + - votekick command +--- + +:::note +This command is currently in beta and may not currently be visible to all users. +::: + +# !votekick + +The `!votekick` command begins a tribunal to kick a user from the chat. + +## Arguments + +- `` - The user to kick from the chat. + +## Example Input + +``` +!votekick @username +``` diff --git a/docs/chatbot/modules/votekick.md b/docs/chatbot/modules/votekick.md new file mode 100644 index 0000000..cbf0a42 --- /dev/null +++ b/docs/chatbot/modules/votekick.md @@ -0,0 +1,34 @@ +--- +id: votekick +tags: + - chatbot + - module + - voteKick +description: A tribunal for chat to decide if a user should be kicked from the chat +keywords: + - streamelements votekick module + - votekick command +--- + +:::note +This module is currently in beta and may not currently be visible to all users. +::: + +# Votekick + +The votekick module is a chatbot module that allows chat to vote on whether or not to kick a user from the chat. This is a great way to enhance engagement from the chat or allow users to keep the chat safer when moderators are not around without giving too much power to the wrong hands. + +### Commands + +- [!votekick](/chatbot/commands/default/votekick) - Begins a votekick tribunal. + +### Settings + +Name | Description +--- | --- +Voting Mode | The mode of voting for the votekick. This can be set to "Twitch Chat" or "Twitch Polls" to use native polls on Twitch. +Minimum Votes | The minimum number of votes required to kick the user. This must be at least 1. +Voting Duration | The duration of the votekick. This can be between 10 and 1800 seconds. +Kick Duration | The length of time (in seconds) that the user will be removed from chat. This can be between 10 and 1209600 seconds. +Yea Keyword | The keyword that will be used as a "yes" vote. It is recommended for this to be an emote. +Nay Keyword | The keyword that will be used as a "no" vote. It is recommended for this to be an emote. From 32e10006f912fa5d5041ac9295a55645247fba83 Mon Sep 17 00:00:00 2001 From: Adeithe <28549467+Adeithe@users.noreply.github.com> Date: Fri, 3 May 2024 11:38:15 -0400 Subject: [PATCH 2/2] Improve example input --- docs/chatbot/commands/default/votekick.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/chatbot/commands/default/votekick.md b/docs/chatbot/commands/default/votekick.md index d506b1d..5e94c04 100644 --- a/docs/chatbot/commands/default/votekick.md +++ b/docs/chatbot/commands/default/votekick.md @@ -25,5 +25,5 @@ The `!votekick` command begins a tribunal to kick a user from the chat. ## Example Input ``` -!votekick @username +!votekick darkoe ```