Merge branch 'main' of github.com:Streamerbot/docs

* 'main' of github.com:Streamerbot/docs:
  Multiple changes including get commands and fixing broken links (#34)
  Update README.md
  Update README.md

README.md

@@ -1,3 +1,14 @@
-# Streamer.bot Docs
+# Streamer.bot Documentation
 
-![Preview](https://docs.streamer.bot/__og_image__/og.png)
+![Streamer.bot Docs](https://img.shields.io/badge/docs-streamerbot?label=Streamer.bot&color=%239c59f1&link=https%3A%2F%2Fdocs.streamer.bot)
+![Speaker.bot Docs](https://img.shields.io/badge/docs-speakerbot?label=Speaker.bot&color=%239c59f1&link=https%3A%2F%2Fspeaker.bot)
+![Discord](https://img.shields.io/discord/834650675224248362?logo=discord&label=Discord&color=rgb(82%2C%2094%2C%20235))
+![GitHub contributors](https://img.shields.io/github/contributors/Streamerbot/docs?logo=github&label=Contributors)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Streamerbot/docs/deploy-streamerbot.yml)
+
+Official home of all documentation content for [Streamer.bot](https://streamer.bot) and [Speaker.bot](https://speaker.bot)
+
+## Contributing
+Contributions are welcome and encouraged!
+
+Guidelines: TBA

streamerbot/2.guide/2.triggers.md

@@ -123,7 +123,7 @@ Enable all triggers for the selected action
 Disable all triggers for the selected action
 
 #### `Always Run`
-Always execute this trigger, even if another matching trigger has been configured elsewhere with an overlapping range.
+Always execute this trigger, even if a another matching trigger has been configured elsewhere with an overlapping range.
 
 ::callout{icon=i-mdi-lightbulb color=amber}
 This is a special option that only applies to [range triggers](#range)

streamerbot/3.api/1.sub-actions/core/commands/Get-Commands.md

@@ -1,60 +1,42 @@
----
-title: Get Commands
-description: Commands Sub-Actions Reference
-published: true
-date: 2023-04-07T22:04:32.578Z
-tags: twitch, commands, chat
-editor: markdown
-dateCreated: 2022-02-27T00:38:17.197Z
----
+# Get Commands
+This sub action allows you to populate the commands and output them to your twitch chat.
 
-This sub action allows you to populate the commands and output them to your twitch chat. Just like the one below
-![get_all_commands_output_.png](/commands/get_all_commands_output_.png =600x)
+:image-preview
 
-To do this all you need to do is create an action and give it a name next go to the sub action window on the right and then right click to get the option menu to open now navigate through the following `Add Action` then `Commands` then click the `Get Commands` Option. Just like the image below.
-![commands_menu.png](/commands/commands_menu.png =600x)
+## Parameters
+### `Group`
+The name of the command group.
 
-Once you have done this a dialog box will appear from here you can select the group of commands you want to be outputted to the user that requested the commands list in your twitch chat. Various options will be displayed depending on how you have grouped your commands in the Commands tab.
-> Note: Due to a limitation on Twitch if your total commands exceed 500 Characters the message to the Twitch chat will **NOT** be sent!!!
-{.is-info}
+### `Variable Name`
+The name of the variable that will be used when running the action. For example, if you use the variable name: "chatCommands". The following variables will be populated: `chatCommands`, `chatCommandsList`
 
-Next field we have is a variable name field here you will need to input a name for all the commands populated to be stored in ready for you to call in a Send to Twitch channel action. So enter a name and remember it. We will need this later.
+### `Include all`
+This option will display all the commands in the specified group regardless of the permissions that have been set for these commands.
 
-![dialog_-group_options_.png](/commands/dialog_-group_options_.png =350x) ![example_catergory_.png](/commands/example_catergory_.png =350x)
+### `Ignore Aliases`
+This option will give you the chance to hide any of your commands other formats for example if you have `!shoutout` and `!so` in the commands box it will only show the 1st one having this option unticked would show both when populating the list.
 
-Next we have 3 check boxes `Include All`, `Ignore Aliases` and `Only Has Permission`
-
-`Include all` option will display all the commands in the specified group regardless of the permissions that have been set but, when paired with the `Only Has Permission` option checked it will only store the commands the user is permitted to use in that variable you have named.
-
-> **Please Note:** The `Include All` checkbox on the sub action overrides the `Include` behaviour on the command itself and will list everything from the group you have selected. There may be commands you don't want to list to the user such as test commands. So be mindful of this.
-{.is-info}
-
-`Ignore Aliases` option will give you the chance to hide any of your commands other formats for example if you have `!shoutout` and `!so` in the commands box it will only show the 1st one having this option unticked would show both when populating the list.
-
-If you do enable the option `Only has permission` make sure at the beginning of the sub action you perform the 'Get User Info for Target' sub action and place it at the top of the sub action list. This is so the Streamer.bot can see if the user that redeemed it is a VIP/Moderator/Subscriber/Viewer and match it to the permissions that has been set on that command.
-
-Lastly create a sub action to output the contents of the variable that is storing the commands. Again right click in the sub action section click `Add Action` then `Twitch` then `Send Message to Twitch Channel`. In here you would type a message and include the variable you named earlier.
-> **For example : "/me These are the commands available to you: %commands%"**
-
-![get_commands_sub_action_list_.png](/commands/get_commands_sub_action_list_.png =700x)
-
-This is one example you can import to get started.
-
-## Import Code
-```
-U0JBRR+LCAAAAAAABACtVclu2zAQvQfIPxACcgtdSZRkKTej66VFUQS5FD1Q5MgmIIkuSSU2gvx7SS3eJBdG4Jv43miWNzPk6+0NQt4zKC1k7T0gct8ColpLZZ52cNjBlahF1VR73PNn4Sz0ehYMtdirO9hjTStwJt+36PPGuevMLEMbs5LKcY+glAD1iSqjd/Q+Gy+Y+TN/R3DQTIm16UnPwW9dbE6PYlPmjLRFfncIGqiWFtz9nxCYBzSb45QHFEc8y+xXTvC8gDQM4iLLgQ+x29/+NtC4kuqmLA9xqGlegvNpVANHzIaVDYcvSlbfhDZSba1RQUt9ZDUo9VFWFa25Pgq6VLJZn2Vp+UK3+ldTT/lV1lxWC9YLNuKZrFmjFNRmijVKLJe2FU7EP0cxx+KeCLxP/EdX2oliXZupEk633sRmM66v61bdirgoy7HCncGylsrygmrQE6W0Riuqf4KqhO5na9JROxcsoX7uc44TSmIczYsEZ35EcMJYATlnacroKMkXEMuV09EO7ClntmtXYeAH5JTadddVd0qenateFg4b5/YQf7v/X0sMbFyK3ocK0OMKNCCqAJkVoEF8RJ+pKF1YZCTayuYBobuBvBtluFZQ2BUGvmBMNu0cjarvRCVZFPmQAE4ID3EUpgHOWJrgkBcsZnFC4ih5n6jnJJ2aucsUDS9XVMtGMXjsczk34u1tNa1LkUYkYCnBYVhwHAVxhmloryNeQOgTKJK5/y5d4rO6jDO5TBX/clUOV39yst+3+5N7feXlj3mUxzwLMIXcd8uf4izOEkwyzgid+zHE5OrLf5XN3x8mbuuvLtT4KmeyLOlaAz/gB7p3ONh3r9+Ri33bDkEjquHVaB/o25u3f/fC+E1mCAAA
-```
+### `Only Has Permission`
+This option will filter out all the commands that the user doesn't has permission to use.
 
 ## Variables
-This sub-action populates 2 variables with the custom name you specify, one as a string and one as a list
+:variables-description
 
 Name | Description
 ----:|:------------
 `<variableName>` | Comma separated string containing all commands matching criteria specified in the sub-action
 `<variableName>List` | List object for C# containing all commands matching criteria specified in the sub-action
 
-## CSharp Example
+## C# Usage
+:csharp-method
+
+## Example Usage
+### Import Code
+``` [sb-import]
+U0JBRR+LCAAAAAAABACtVclu2zAQvQfIPxACcgtdSZRkKTej66VFUQS5FD1Q5MgmIIkuSSU2gvx7SS3eJBdG4Jv43miWNzPk6+0NQt4zKC1k7T0gct8ColpLZZ52cNjBlahF1VR73PNn4Sz0ehYMtdirO9hjTStwJt+36PPGuevMLEMbs5LKcY+glAD1iSqjd/Q+Gy+Y+TN/R3DQTIm16UnPwW9dbE6PYlPmjLRFfncIGqiWFtz9nxCYBzSb45QHFEc8y+xXTvC8gDQM4iLLgQ+x29/+NtC4kuqmLA9xqGlegvNpVANHzIaVDYcvSlbfhDZSba1RQUt9ZDUo9VFWFa25Pgq6VLJZn2Vp+UK3+ldTT/lV1lxWC9YLNuKZrFmjFNRmijVKLJe2FU7EP0cxx+KeCLxP/EdX2oliXZupEk633sRmM66v61bdirgoy7HCncGylsrygmrQE6W0Riuqf4KqhO5na9JROxcsoX7uc44TSmIczYsEZ35EcMJYATlnacroKMkXEMuV09EO7ClntmtXYeAH5JTadddVd0qenateFg4b5/YQf7v/X0sMbFyK3ocK0OMKNCCqAJkVoEF8RJ+pKF1YZCTayuYBobuBvBtluFZQ2BUGvmBMNu0cjarvRCVZFPmQAE4ID3EUpgHOWJrgkBcsZnFC4ih5n6jnJJ2aucsUDS9XVMtGMXjsczk34u1tNa1LkUYkYCnBYVhwHAVxhmloryNeQOgTKJK5/y5d4rO6jDO5TBX/clUOV39yst+3+5N7feXlj3mUxzwLMIXcd8uf4izOEkwyzgid+zHE5OrLf5XN3x8mbuuvLtT4KmeyLOlaAz/gB7p3ONh3r9+Ri33bDkEjquHVaB/o25u3f/fC+E1mCAAA
+```
 
+### C# Code
 Since Twitch has a message charater limit of 500 and on YouTube it's 200 you may find your commands overtake this amount therefore the code below can help with splitting the list into batches of commands that fit inside the messages.
 
 ```cs
@@ -73,19 +55,14 @@ public class CPHInline
         {
             if ((commands[i].Length + message.Length) > messageMax)
             {
-                CPH.SendMessage(message, bot); // This will need to be changed to CPH.SendYouTubeMessage(message, bot); if you wish to send the message to Youtube
+                CPH.SendAction(message, bot); // This will need to be changed to CPH.SendYouTubeMessage(message, bot); if you wish to send the message to Youtube
                 message = "Addional Commands for you: ";
             }
 
             message += commands[i] + ", ";
         }
-        CPH.SendMessage(message, bot); // This will need to be changed to CPH.SendYouTubeMessage(message, bot); if you wish to send the message to Youtube
+        CPH.SendAction(message, bot); // This will need to be changed to CPH.SendYouTubeMessage(message, bot); if you wish to send the message to Youtube
         return true;
     }
 }
-```  
-
----
-
-- [<i class="mdi mdi-chevron-left"></i> **Commands Sub-Actions Reference *Go Back***](/Sub-Actions/Commands)
-{.btn-grid .my-5}
+```

streamerbot/3.api/1.sub-actions/obs/streaming.md

@@ -11,12 +11,6 @@ Choose the streaming state
 - `Start`: Start your streaming
 - `Stop`: Stop your streaming
 
-### State
-Name | Description
-----:|:------------
-`Stop` | Stops your OBS Stream
-`Start` | Starts your OBS Stream
-
 ## C# Usage
 :csharp-method{name=ObsStopStreaming}
 :csharp-method{name=ObsStartStreaming}

streamerbot/3.api/1.sub-actions/speakerbot/clear-pending.md

@@ -0,0 +1,12 @@
+# Clear Pending
+Speaker.bot clear pending sub-action.
+
+::list{type=warning}
+- Check out the [Speaker.bot Integration Guide](/guide/integrations/speakerbot) for information about configuring Speaker.bot
+::
+
+## Details
+Clear the current pending queue.
+
+## C# Usage
+:csharp-method

streamerbot/3.api/1.sub-actions/speakerbot/speak-udp.md

@@ -1,5 +1,21 @@
----
-title: Speak (UDP)
----
+# Speak (UDP)
+Send a message with text-to-speech (TTS) using Speaker.bot with UDP
 
-:wip
+:image-preview
+
+::list{type=warning}
+- Check out the [Speaker.bot Integration Guide](/guide/integrations/speakerbot) for information about configuring Speaker.bot
+::
+
+## Parameters
+### `Voice Alias`
+Enter the name of the voice alias to use
+
+### `Pass Through Bad Word Filter`
+Toggle the bad word filter on or off
+
+### `Message`
+Enter the message content to send to Speaker.bot
+
+## C# Usage
+:csharp-method{name=TtsSpeak}

streamerbot/3.api/1.sub-actions/speakerbot/speak.md

@@ -1,5 +1,6 @@
 # Speak
 Send a message with text-to-speech (TTS) using Speaker.bot
+
 :image-preview
 
 ::list{type=warning}
@@ -8,13 +9,28 @@ Send a message with text-to-speech (TTS) using Speaker.bot
 
 ## Parameters
 ### `Voice Alias`
-Enter the name of the voice alias to use
+Enter the name of the voice alias to use.
 
 ### `Pass Through Bad Word Filter`
-Toggle the bad word filter on or off
+Toggle the bad word filter on or off.
+
+### `Silent`
+Will play the TTS silently. Can be used with the delay option if you want to wait before the TTS is finished, but don't have the audio.
+
+### `Delay`
+With this option the adjacent sub-action will wait for execution till the TTS has finished playing.
 
 ### `Message`
-Enter the message content to send to Speaker.bot
+Enter the message content to send to Speaker.bot.
+
+## Variables
+:variables-description
+
+Name | Description
+----:|:------------
+`success` | If the speak sub-action was successful `True`/`False`
+`speechFile` | The speech file or when it doesn't exist `null`
+`duration` | The duration of the speech when the delay option is used
 
 ## C# Usage
-:csharp-method{name=TtsSpeak}
+:csharp-method

streamerbot/3.api/1.sub-actions/speakerbot/stop-speaking.md

@@ -0,0 +1,12 @@
+# Stop Speaking
+Speaker.bot stop speaking sub-action.
+
+::list{type=warning}
+- Check out the [Speaker.bot Integration Guide](/guide/integrations/speakerbot) for information about configuring Speaker.bot
+::
+
+## Details
+Stop the current playing TTS.
+
+## C# Usage
+:csharp-method

streamerbot/3.api/2.triggers/trovo/chat/chat-message.md → streamerbot/3.api/2.triggers/trovo/chat/message.md

@@ -1,4 +1,4 @@
-# Chat message
+# Chat Message
 Trovo chat message trigger.
 
 ## Details

streamerbot/3.api/2.triggers/youtube/broadcast/broadcast-ended.md → streamerbot/3.api/2.triggers/youtube/broadcast/ended.md

@@ -3,4 +3,8 @@
 ## Variables
 :variables-description{empty}
 
+::callout{icon=i-mdi-lightbulb color=primary}
+The `broadcastId` variable is not available here.
+::
+
 :variables{name=YouTubeBroadcaster disclosure}

streamerbot/3.api/3.csharp/core/0.index.md

@@ -51,11 +51,11 @@ Write a new log with level `Verbose`
 
 ## Advanced
 ### `GetSource`
-Get the value of the `eventSource` variable
+Get the value of the `__source` variable
 :csharp-method{name=GetSource}
 
 ### `GetEventType`
-Get the value of the `__source` variable
+Get the value of the `eventType` variable
 :csharp-method{name=GetEventType}
 
 ### `CSharpExecuteMethod`

streamerbot/3.api/3.csharp/twitch/ads.md

@@ -4,4 +4,7 @@ description: Control Twitch ads from your code actions
 ---
 
 ## `TwitchRunCommercial`
-:csharp-method{name=TwitchRunCommercial}
+:csharp-method{name=TwitchRunCommercial}
+
+## `TwitchGetPrerollFreeTime`
+:csharp-method{name=TwitchGetPrerollFreeTime}

streamerbot/3.api/3.csharp/twitch/throwing-system.md

@@ -0,0 +1,10 @@
+---
+title: Twitch Integrated Throwing System
+description: Control the Twitch throwing system from your code actions
+---
+
+## `ThrowingSystemThrowItemByName`
+:csharp-method{name=ThrowingSystemThrowItemByName}
+
+## `ThrowingSystemActivateTriggerByName`
+:csharp-method{name=ThrowingSystemActivateTriggerByName}