diff --git a/docs/chatbot/commands/default/index.md b/docs/chatbot/commands/default/index.md new file mode 100644 index 0000000..02277cc --- /dev/null +++ b/docs/chatbot/commands/default/index.md @@ -0,0 +1,5 @@ +# Default Commands + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/chatbot/filters/bannedwords.md b/docs/chatbot/filters/bannedwords.md index 0b16b2b..f4dcfcb 100644 --- a/docs/chatbot/filters/bannedwords.md +++ b/docs/chatbot/filters/bannedwords.md @@ -6,8 +6,6 @@ tags: --- # Banned words -## Overview - The Banned Words filter is a tool that helps maintain the chat environment by removing messages that contain banned phrases and patterns. This filter is highly customizable and supports the creation of multiple groups, each with its own set of banned phrases. These phrases can be simple text or they can be regular expressions (regexp), providing a high degree of flexibility in defining what constitutes a banned phrase. For example, you could ban a specific word, or use a regular expression to ban any word that contains a certain sequence of characters. diff --git a/docs/chatbot/filters/caps.md b/docs/chatbot/filters/caps.md index f6a5c48..34bdaab 100644 --- a/docs/chatbot/filters/caps.md +++ b/docs/chatbot/filters/caps.md @@ -6,8 +6,6 @@ tags: --- # Caps -### Description - The Caps filter helps manage the use of capital letters in chat messages. It checks the number and percentage of capital letters in a message and compares them with the set limits. If a message violates these limits, the filter takes action according to the configured settings. ### Supported Settings diff --git a/docs/chatbot/filters/emotes.md b/docs/chatbot/filters/emotes.md index 9ca6ff8..118878e 100644 --- a/docs/chatbot/filters/emotes.md +++ b/docs/chatbot/filters/emotes.md @@ -6,8 +6,6 @@ tags: --- # Emotes -### Description - The Emote filter helps manage the use of emotes in chat messages. It checks the number of emotes in a message and compares them with the set limit. If a message violates this limit, the filter takes action according to the configured settings. ### Supported Settings diff --git a/docs/chatbot/filters/index.md b/docs/chatbot/filters/index.md new file mode 100644 index 0000000..e0e1f65 --- /dev/null +++ b/docs/chatbot/filters/index.md @@ -0,0 +1,5 @@ +# Spam Filters + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/chatbot/filters/links.md b/docs/chatbot/filters/links.md index 8d2c832..9ddbe8b 100644 --- a/docs/chatbot/filters/links.md +++ b/docs/chatbot/filters/links.md @@ -6,8 +6,6 @@ tags: --- # Links -### Description - The Link filter helps manage the posting of links in chat messages. It checks if a message contains any links and compares them with the set allowlist and blocklist. If a message contains a link that is not in the allowlist or is in the blocklist, the filter takes action according to the configured settings. ### Supported Settings diff --git a/docs/chatbot/filters/paragraph.md b/docs/chatbot/filters/paragraph.md index 01ac246..c51fbb3 100644 --- a/docs/chatbot/filters/paragraph.md +++ b/docs/chatbot/filters/paragraph.md @@ -6,8 +6,6 @@ tags: --- # Paragraph -### Description - The Paragraph filter helps manage the length of chat messages. It checks the number of characters in a message and compares them with the set limit. If a message violates this limit, the filter takes action according to the configured settings. ### Supported Settings diff --git a/docs/chatbot/filters/symbol.md b/docs/chatbot/filters/symbol.md index fb5d249..2b52da1 100644 --- a/docs/chatbot/filters/symbol.md +++ b/docs/chatbot/filters/symbol.md @@ -6,8 +6,6 @@ tags: --- # Symbol -### Description - The Symbol filter helps manage the use of symbols in chat messages. It checks the number and percentage of symbols in a message and compares them with the set limits. If a message violates these limits, the filter takes action according to the configured settings. ### Supported Settings diff --git a/docs/chatbot/index.md b/docs/chatbot/index.md index e147451..a0af5af 100644 --- a/docs/chatbot/index.md +++ b/docs/chatbot/index.md @@ -5,12 +5,8 @@ sidebar_position: 1 --- # Chatbot -This documentation provides an in-depth guide on how to utilize our Chatbot. It encompasses various features including: +This documentation provides an in-depth guide on how to utilize our Chatbot. It encompasses various features including -- [Custom Commands](./chatbot/commands/custom): Detailed guidelines on how to formulate your own commands specific to your channel and audience. -- [Modules](./chatbot/modules): A collection of modules that can be enabled and configured to suit your needs. -- [Timers](./chatbot/timers): A detailed guide on how to create and manage timers. -- [Variables](./chatbot/variables): A list of variables that can be used in commands and modules. -- [Spam Filters](./chatbot/filters): A list of spam filters that can be enabled and configured to suit your needs. +import DocCardList from '@theme/DocCardList'; -For further detailed information, please navigate to the corresponding sections. + diff --git a/docs/chatbot/modules/bingo.md b/docs/chatbot/modules/bingo.md index 5e90bed..f33628c 100644 --- a/docs/chatbot/modules/bingo.md +++ b/docs/chatbot/modules/bingo.md @@ -7,7 +7,7 @@ tags: # Bingo -The StreamElements emote bingo module is an interactive chat game. In this game, a bingo card is generated with a variety of emotes. +The emote bingo module is an interactive chat game. In this game, a bingo card is generated with a variety of emotes. **How the game works:** diff --git a/docs/chatbot/modules/chatalerts.md b/docs/chatbot/modules/chatalerts.md index 89b275a..6d2e2c9 100644 --- a/docs/chatbot/modules/chatalerts.md +++ b/docs/chatbot/modules/chatalerts.md @@ -7,7 +7,7 @@ tags: # Chat Alerts -The StreamElements chat alerts module is a feature that allows the chatbot to post messages in the chat when certain events occur. These events can include, but are not limited to, receiving a tip, gaining a new follower, or being raided. +The chatalerts module is a feature that allows the chatbot to post messages in the chat when certain events occur. These events can include, but are not limited to, receiving a tip, gaining a new follower, or being raided. **How the module works:** diff --git a/docs/chatbot/modules/duel.md b/docs/chatbot/modules/duel.md index 5de92c4..49f5787 100644 --- a/docs/chatbot/modules/duel.md +++ b/docs/chatbot/modules/duel.md @@ -7,7 +7,7 @@ tags: # Duel -The StreamElements chatbot duel module is an interactive chat game. In this game, users can challenge each other to a duel. +The duel module is an interactive chat game. In this game, users can challenge each other to a duel. **How the game works:** diff --git a/docs/chatbot/modules/eightball.md b/docs/chatbot/modules/eightball.md index a7641ed..37ffcfd 100644 --- a/docs/chatbot/modules/eightball.md +++ b/docs/chatbot/modules/eightball.md @@ -7,7 +7,7 @@ tags: # Eightball -The StreamElements 8ball module is an interactive chat feature. In this module, users can ask the 8ball a question, and it will respond with a random answer. The answers can be customized in the module settings. +The 8ball module is an interactive chat feature. In this module, users can ask the 8ball a question, and it will respond with a random answer. The answers can be customized in the module settings. **How the module works:** diff --git a/docs/chatbot/modules/emotecombo.md b/docs/chatbot/modules/emotecombo.md index e0398bc..5b9afac 100644 --- a/docs/chatbot/modules/emotecombo.md +++ b/docs/chatbot/modules/emotecombo.md @@ -7,7 +7,7 @@ tags: # Emote Combo -The StreamElements emote combo module is an interactive chat feature. In this module, users try to send the same emote consecutively in the chat. +The emote combo module is an interactive chat feature. In this module, users try to send the same emote consecutively in the chat. **How the module works:** diff --git a/docs/chatbot/modules/emotepyramid.md b/docs/chatbot/modules/emotepyramid.md index 6cd3342..df906d9 100644 --- a/docs/chatbot/modules/emotepyramid.md +++ b/docs/chatbot/modules/emotepyramid.md @@ -7,7 +7,7 @@ tags: # Emote Pyramid -The StreamElements emote pyramid module is a fun chat game. In this game, users attempt to create a pyramid of emotes in the chat. +The emote pyramid module is a fun chat game. In this game, users attempt to create a pyramid of emotes in the chat. **How the game works:** diff --git a/docs/chatbot/modules/index.md b/docs/chatbot/modules/index.md index 0d5b3ab..43317fb 100644 --- a/docs/chatbot/modules/index.md +++ b/docs/chatbot/modules/index.md @@ -4,6 +4,9 @@ description: Chatbot modules are a set of tools designed to enhance viewer inter # Modules -## Introduction - Chatbot modules are a set of tools designed to enhance viewer interaction and engagement in your live stream. They provide a variety of functionalities such as managing viewer queues, making live announcements, playing games like eightball and slotmachine, and triggering emotecombo reactions. Each module can be customized to fit the unique needs of your stream. + + +import DocCardList from '@theme/DocCardList'; + + diff --git a/docs/chatbot/modules/liveannouncement.md b/docs/chatbot/modules/liveannouncement.md index 9ae3a51..356ef24 100644 --- a/docs/chatbot/modules/liveannouncement.md +++ b/docs/chatbot/modules/liveannouncement.md @@ -7,7 +7,7 @@ tags: # Live Announcement -The StreamElements live announcement module is a feature that allows the chatbot to post a message in the chat when the stream goes live. +The live announcement module is a feature that allows the chatbot to post a message in the chat when the stream goes live. **How it works:** diff --git a/docs/chatbot/modules/raffle.md b/docs/chatbot/modules/raffle.md index 478c89e..979d73a 100644 --- a/docs/chatbot/modules/raffle.md +++ b/docs/chatbot/modules/raffle.md @@ -7,7 +7,7 @@ tags: # Raffle -The StreamElements raffle module is an interactive chat game. In this game, a raffle is initiated by a moderator and users can join the raffle by using a specific command. +The raffle module is an interactive chat game. In this game, a raffle is initiated by a moderator and users can join the raffle by using a specific command. **How the game works:** diff --git a/docs/chatbot/modules/roulette.md b/docs/chatbot/modules/roulette.md index a948d02..8083559 100644 --- a/docs/chatbot/modules/roulette.md +++ b/docs/chatbot/modules/roulette.md @@ -7,7 +7,7 @@ tags: # Roulette -The StreamElements chatbot roulette module is an interactive chat game. In this game, users can wager their points in a roulette-style gamble. +The roulette module is an interactive chat game. In this game, users can wager their points in a roulette-style gamble. **How the game works:** diff --git a/docs/chatbot/modules/slotmachine.md b/docs/chatbot/modules/slotmachine.md index e50d9d8..4946a54 100644 --- a/docs/chatbot/modules/slotmachine.md +++ b/docs/chatbot/modules/slotmachine.md @@ -7,7 +7,7 @@ tags: # Slotmachine -The StreamElements slotmachine module is an interactive chat game. In this game, users can wager their points on a virtual slot machine that is based on emotes. +The slotmachine module is an interactive chat game. In this game, users can wager their points on a virtual slot machine that is based on emotes. **How the game works:** diff --git a/docs/chatbot/modules/viewerqueue.md b/docs/chatbot/modules/viewerqueue.md index 6812058..bc57aa4 100644 --- a/docs/chatbot/modules/viewerqueue.md +++ b/docs/chatbot/modules/viewerqueue.md @@ -6,7 +6,7 @@ tags: --- # Viewer queue -The StreamElements viewer queue module allows the creation of a queue where viewers can join and be selected. This module is useful for managing viewer interactions during live streams. +The viewer queue module allows the creation of a queue where viewers can join and be selected. This module is useful for managing viewer interactions during live streams. ### Commands diff --git a/docs/chatbot/variables/index.md b/docs/chatbot/variables/index.md index c7eacea..aed26af 100644 --- a/docs/chatbot/variables/index.md +++ b/docs/chatbot/variables/index.md @@ -9,3 +9,8 @@ For example, in the command `${uptime shroud}`, `shroud` is a variable represent Variables make chat commands more flexible and powerful, allowing for a wide range of interactions and functionalities. In addition to the `${}` syntax, we also support the `$()` syntax for variables. Both of these syntaxes can be used interchangeably in chat commands. For instance, the command `${uptime shroud}` can also be written as `$(uptime shroud)`. + +import DocCardList from '@theme/DocCardList'; + + + diff --git a/docusaurus.config.js b/docusaurus.config.js index 6a79519..b1f235b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,7 +8,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); const config = { title: 'StreamElements Docs', tagline: 'The official documentation for StreamElements', - favicon: 'img/favicon.png', + favicon: 'img/favicon.ico', // Set the production url of your site here url: 'https://docs.streamelements.com', @@ -63,7 +63,7 @@ const config = { title: 'StreamElements Docs', }, metadata: [ - {name: 'keywords', content: 'Streaming,Chatbot,documentation,StreamElements,Live Streaming,Guides,Tutorials,Help,Support,FAQ,How-to,Stream Setup,Stream Tools,StreamElements Features,StreamElements Services'}, + {name: 'keywords', content: 'Streaming,Chatbot,documentation,StreamElements,Live Streaming,Guides,Tutorials,Help,How-to,Stream Setup,Stream Tools,StreamElements Features'}, {name: 'twitter:card', content: 'summary_large_image'}, ], colorMode: { @@ -77,9 +77,13 @@ const config = { title: 'Docs', items: [ { - label: 'Tutorial', - to: '/', + label: 'Getting Started', + to: '/chatbot/gettingstarted/customcommands/creating', }, + { + label: 'Variables', + to: '/chatbot/variables', + } ], }, { diff --git a/static/img/favicon.ico b/static/img/favicon.ico new file mode 100644 index 0000000..d878869 Binary files /dev/null and b/static/img/favicon.ico differ