Describe the missing documentation
Twitch Upcoming Ad Trigger being added to v0.2.3

Where do you think this documentation should be included? An existing page or new page?
New page needed https://docs.streamer.bot/api/triggers/twitch/ads/upcoming-ad

Additional context
"%minutes%" "5"
"%nextAdAt%" "2024-03-03 01:10:20"
"%snoozesLeft%" "3"
"%adLength%" "150"

Attached is a list of variables

Describe the missing documentation
Crowd Control Effect Failure Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Effect Failure doesn't exist

Additional context

Describe the missing documentation
Linux setup docs need ported over from the Wiki

Where do you think this documentation should be included? An existing page or new page?
Somewhere under /guide

Additional context
Need to heavily test and rewrite / cleanup the existing Linux docs

Describe the missing documentation
The image in the Twitch Add Moderator Subaction Page is outdated.

Where do you think this documentation should be included? An existing page or new page?
Existing page

Additional context
This is how it looks now.

Describe the missing documentation
Missing Datas for Variables from Chat Message trigger :

• bits (int)
• monthsSubscribed (int)

Missing isReply specifics variables :

• reply.msgId (string)
• reply.userId (string)
• reply.userLogin (string)
• reply.userName (string)
• reply.msgBody (string) (! message include \s for each space )
• reply.threadMsgId (string)
• reply.threadUserLogin (string)

Where do you think this documentation should be included? An existing page or new page?
existing, Here.

Additional context

isReply variable after run viewer

current display

Describe the missing documentation
link to full references of all OBS WebSocket 5 events

Where do you think this documentation should be included? An existing page or new page?
existing : /api/triggers/obs/event

Additional context
obs-websocket-doc

Describe the missing documentation
Most of the old settings docs need brought over.

Where do you think this documentation should be included? An existing page or new page?
See existing WIP page at /guide/settings

Additional context
Things like the C# Compiler settings should probably be documented in their own respective areas, e.g. /guide/csharp, when they already exist.

Describe the missing documentation
Crowd Control Timed Effect Started Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Timed Effect Started doesn't exist

Additional context

Describe the missing documentation
The new Speaker.bot docs are empty and old wiki docs are lacking information about variables available to use. There was confusion about how to use Speaker.bot in the Discord: https://discord.com/channels/834650675224248362/989594347152490516/1212929413507715082

Where do you think this documentation should be included? An existing page or new page?

https://docs.streamer.bot/guide/integrations/speakerbot

Describe the missing documentation
File update for the HTML overlay ( v1.0.1 )

Where do you think this documentation should be included? An existing page or new page?
file exist : /guide/extra-features/html-overlay#download

Additional context
Github link to the new file
this is stored in a location I can't directly access

Describe the bug
When the Dual Output feature is enabled in Streamlabs, Streamer.bot's Streamlabs Action can only control the visibility of the Vertical output source, Horizontal output does not take effect.

To Reproduce
Steps to reproduce the behavior:

1. Enable Dual Output Mode in Streamlabs OBS;
2. Add Streamlabs connection in Streamer.bot;
3. Add Streamlabs Source Visibility Action in Streamer.bot;
4. Test the Action, only the source in Vertical output in Streamlabs works, not Horizontal output;
5. Disable Streamlabs' Dual Ouput Mode, leaving the Horizontal output;
6. Test the Action again, nothing happen.

Expected behavior
Streamlabs Source Visibility Control Action should work in both Horizontal and Vertical output;

Screenshots

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context

Describe the missing documentation
Action queues documentation needs added
Old Wiki Docs Here

Where do you think this documentation should be included? An existing page or new page?
See existing WIP tag on /guide/actions

Additional context
Old docs are pretty verbose and can be cleaned up a good bit

Describe the missing documentation
Crowd Control Timed Effect Ended Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Timed Effect Ended doesn't exist

Additional context

Describe the missing documentation
Crowd Control Effect Success Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Effect Success doesn't exist yet

Additional context

Describe the missing documentation
Badges are not shown as available data from Cheers event

Where do you think this documentation should be included? An existing page or new page?
https://docs.streamer.bot/api/triggers/twitch/chat/cheer

Additional context

Describe the missing documentation
Everything related to the streamer.bot Chat

Where do you think this documentation should be included? An existing page or new page?
new: /guide/chat

Additional context

Describe the missing documentation
Crowd Control Game Session End Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Game Session End doesn't exist yet

Additional context

Describe the missing documentation
Twitch Channel Points need ported over from the old wiki page

Where do you think this documentation should be included? An existing page or new page?
Existing location at /guide/platforms/twitch

Describe the missing documentation
Import & Export details from Wiki need to be ported over to the need docs.

Where do you think this documentation should be included? An existing page or new page?
/guide/import-export

Describe the missing documentation
Add VStream triggers pages with variables in YAML frontmatter

Where do you think this documentation should be included? An existing page or new page?
/api/triggers/vstream/<trigger>

Additional context
Variable data from TerrierDarts:

//VStream Triggers

//Present Viewers
{
    "__source" :" VStreamPresentViewers",
    "users" : "System.Collections.Generic.List`1[System.Collections.Generic.Dictionary`2[System.String,System.Object]]",
    "isLive" : true,
    "title" : "Test Stream",
    "description" : "",
    "contentWarning" : "none",
    "liveAt" : "08/03/2024 11:45:39 PM",
    "scheduledTime" : "08/03/2024 11:53:35 PM",
    "tags" : "",
    "status" : "live",
    "type" : "livestream",
    "vodVisibility" : "public",
    "triggerId" : "656a2abc-8604-46f1-a409-37bb35fbc288",
    "triggerName" : "Present Viewers",
    "triggerCategory" : "VStream/General",
    "actionId" : "1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5",
    "actionName" : "VStream Testing",
    "eventSource" : "vstream",
    "runningActionId" : "d4beef90-b18a-4b25-b0d3-d1e26caff3c2",
    "actionQueuedAt" : "08/03/2024 11:53:36 PM"
}

//User Data Example
  {
    "id": "chan_01hhaj4h2ee00bzhgd1ceaefa2",
    "userName": "TerrierDarts",
    "display": "terrierdarts",
    "role": 4,
    "isSubscribed": false,
    "isModerator": true
  }

__source = VStreamChatMessage
 messageId = chat_4ngvd3qbb780rakfe1vsmg90he
 createdAt = 09/03/2024 12:13:15 AM
 color = #89e56f
 colorR = 137
 colorG = 229
 colorB = 111
 message = aaa
 emojis = []
 rawInput = aaa
 rawInputEscaped = aaa
 rawInputUrlEncoded = aaa
 input0 = aaa
 inputEscaped0 = aaa
 inputUrlEncoded0 = aaa
 triggerId = 7c245063-658c-42d9-83bb-1cd0b2b218ba
 triggerName = Chat Message
 triggerCategory = VStream/Chat
 actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
 actionName = VStream Testing
 user = terrierdarts
 userName = TerrierDarts
 userId = chan_01hhaj4h2ee00bzhgd1ceaefa2
 userType = vstream
 isModerator = True
 userPreviousActive = 09/03/2024 12:13:17 AM
 eventSource = vstream
 runningActionId = 7837ee38-bafe-4c1a-ae31-a87434c428e9
 actionQueuedAt = 09/03/2024 12:13:17 AM


 __source = VStreamFirstWords
 messageId = chat_4ngvd3qbb780rakfe1vsmg90he
 createdAt = 09/03/2024 12:13:15 AM
 color = #89e56f
 colorR = 137
 colorG = 229
 colorB = 111
 message = aaa
 rawInput = aaa
 rawInputEscaped = aaa
 rawInputUrlEncoded = aaa
 input0 = aaa
 inputEscaped0 = aaa
 inputUrlEncoded0 = aaa
 emojis = []
 triggerId = 3e83e34a-81e1-4bcc-b9a8-0c5ddcf0175c
 triggerName = First Words
 triggerCategory = VStream/General
 actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
 actionName = VStream Testing
 user = terrierdarts
 userName = TerrierDarts
 userId = chan_01hhaj4h2ee00bzhgd1ceaefa2
 userType = vstream
 isModerator = True
 userPreviousActive = 09/03/2024 12:13:17 AM
 eventSource = vstream
 runningActionId = ed5e2b04-6079-436e-bea1-50cdc8c3999d
 actionQueuedAt = 09/03/2024 12:13:17 AM


__source = VStreamChatDeleted
chatId = chat_7hmadefay98bttp1p738cn8s13
videoChannelId = chan_01hhaj4h2ee00bzhgd1ceaefa2
videoId = video_7gntp4zxhg94avaaarq47fk713
triggerId = 041a0a4a-1498-42de-869b-27fba2ec0b95
triggerName = Chat Deleted
triggerCategory = VStream/Chat
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
eventSource = vstream
runningActionId = 169f5a2f-d69a-440d-8792-990ae9969e3b
actionQueuedAt = 09/03/2024 12:16:24 AM


triggerId = d7575e7b-b999-4f8e-aa91-92816f8cfbdf
triggerName = Broadcaster Chat Disconnected
triggerCategory = VStream/Connections
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
runningActionId = 05a52f3d-91af-442f-9ff2-4f8ab9cef61c
actionQueuedAt = 09/03/2024 12:18:04 AM

triggerId = 803f6036-dd61-4b89-9c5b-9325d385f9bc
triggerName = Broadcaster Chat Connected
triggerCategory = VStream/Connections
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
runningActionId = 654e2d34-00eb-4198-a516-2268a3c35997
actionQueuedAt = 09/03/2024 12:18:08 AM

triggerId = be55f829-e4c2-46e6-afba-c4af802ba2c8
triggerName = Broadcaster Authenticated
triggerCategory = VStream/Connections
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
runningActionId = a98edcbf-f2a9-4916-ba34-c492a5fdff54
actionQueuedAt = 09/03/2024 12:19:32 AM

__source = VStreamNewFollower
triggerId = dd98b267-b5db-4da9-ace6-0e4d6d11d6d6
triggerName = New Follower
triggerCategory = VStream/Channel
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
user = lyfesaver
userName = Lyfesaver
userId = chan_01hrg9sffwe00a0mt9c7zfvm7n
userType = vstream
isModerator = False
userPreviousActive = 09/03/2024 12:29:38 AM
eventSource = vstream


__source = VStreamStreamOffline
triggerId = 9c02151d-894e-4815-a80f-93fa4984e676
triggerName = Stream Offline
triggerCategory = VStream/Channel
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
eventSource = vstream
runningActionId = c4330194-466f-4fe4-8e61-526ce43bcd80
actionQueuedAt = 09/03/2024 12:55:02 AM

__source = VStreamStreamOnline
title = test
description = 
vodVisibility = public
triggerId = c78610a5-39de-4d1b-a743-48be5a53c148
triggerName = Stream Online
triggerCategory = VStream/Channel
actionId = 1cff8d9b-56a5-41a4-9fe7-4ea58816bcb5
actionName = VStream Testing
eventSource = vstream
runningActionId = 908864bc-ce55-4918-a2ae-ef053f90fa26
actionQueuedAt = 09/03/2024 12:56:06 AM




//TARGET USER
`%targetUser%`
`%targetUserName%`
`%targetUserId%`
`%targetUserPlatform%`
`%targetBackstory%`
`%targetIntroduction%`
`%targetUserProfileImageUrl%`
`%targetUserProfileImageEscaped%`
`%targetUserStatus%`
`%targetLastActive%`
`%targetPreviousActive%`
`%targetIsSubscribed%`
`%targetIsModerator%`


//Ban
`%bannedUser%`
`%bannedUserName%`
`%bannedUserId%`
`%bannedUserType%`
`%banResult%`

Describe the missing documentation
There is currently no explanation on how to access the new variables created from the FetchURL with parse JSON feature.

Where do you think this documentation should be included? An existing page or new page?
One the Fetch URL page

Describe the missing documentation
Crowd Control Game Session Start Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Game Session Start doesn't exist yet

Additional context

Describe the missing documentation
Crowd Control Effect Request Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Effect Request doesn't exist yet

Additional context

See: keyboard-press.md

If you open it up, you'll see that the hyperlinked image does not show.

Is your feature request related to a problem? Please describe.
Some arguments/variables reference C# structures which require extended documentation

Describe the solution you'd like
Develop a method to "click in" to view complex variable types

Additional context
See Trovo users dictionary at https://docs.streamer.bot/api/triggers/trovo/general/present-viewers

Describe the missing documentation
Add additional context for registering custom triggers within Init()

Where do you think this documentation should be included? An existing page or new page?
https://docs.streamer.bot/guide/triggers#custom-triggers

Additional context
From @Rhondi Discord Post

When registering custom triggers, it's best practice to register them in the public void Init() method. And also adjust the Execute C# Code sub-action to Precompile on Application Start

public void Init()
{
    CPH.RegisterCustomTrigger("New Twitch Clip Found", "clip_found", new[] {"Twitch"});
}

Describe the missing documentation
It's not exactly clear (just from looking at documentation) what each value in int state does.

• 0 = enable
• 1 = disable
• 2 = toggle

Where do you think this documentation should be included? An existing page or new page?
https://docs.streamer.bot/api/csharp/method/ObsSetFilterState

Describe the missing documentation
Port existing docs from gist markdown (link below)

Where do you think this documentation should be included? An existing page or new page?
Either a _partial page or new tutorials area, linked from the C# guide page.

Additional context
Rondhi's Gist

Describe the missing documentation
MIDI docs need ported from the old Wiki

Where do you think this documentation should be included? An existing page or new page?
Existing page at https://docs.streamer.bot/guide/midi

Additional context
Review any changes in recent Streamer.bot versions

Describe the missing documentation
Backup & Restore guide needs ported from the old Wiki and updated for existing Streamer.bot versions.

Where do you think this documentation should be included? An existing page or new page?
https://docs.streamer.bot/guide/backup

Describe the bug
Using API Ninjas the JSON response is not being parsed by Streamer Bot and is instead throwing an error.
[2024-05-01 06:40:50.216 ERR] Unable to parse result as json, falling back to auto typing [{"fact": "Cows do not have any upper front teeth. Instead they have a thick pad on the top jaw"}] Newtonsoft.Json.JsonReaderException: Error reading JObject from JsonReader. Current JsonReader item is not an object: StartArray. Path '', line 1, position 1. at Newtonsoft.Json.Linq.JObject.Load(JsonReader reader, JsonLoadSettings settings) at Newtonsoft.Json.Linq.JObject.Parse(String json, JsonLoadSettings settings) at _3i0Lzx2wqGliKlNC7CtMlJ3XEbJ._7FLWL4s233ypQDlEhdJDrtFUCrh.MoveNext()

To Reproduce
Steps to reproduce the behavior:

1. Create new action
2. Create trigger
3. Create sub action to fetch URL and configure it for API ninjas (https://api-ninjas.com/api/dadjokes) will need account setting the parse JSON option
4. See error

Expected behavior
It should parse the JSON and allow us to use the generated variables to access the data.

Desktop (please complete the following information):

• OS: Windows 10
• Version 0.2.3

Additional context
It seems because it is returning as an array vs dictionary at the start that Streamerbot is having a challenge parsing the data.

Describe the missing documentation
Crowd Control Timed Effect Update Trigger

Where do you think this documentation should be included? An existing page or new page?
Trigger page for Crowd Control Timed Effect Update doesn't exist

Additional context

I don't fully understand how this one is triggered, as it has almost identical variables to the Timed Effect Started/Ended triggers, other than it has variables for who redeemed the effect.

Describe the missing documentation
Accessing and using the update option from hamburger button

Where do you think this documentation should be included? An existing page or new page?
new page: /guide/update
Update Page from Old wiki

Additional context

Is your feature request related to a problem? Please describe.
Currently the C# pages are a mixture of autogenerated method definitions and the old wiki-imported pages which were sorting them out in to various 'categories'.

We need a better way to continue to categorize methods and add custom supplementary information while using auto-generation as the primary source of content.

Describe the solution you'd like

• Consider the benefits/drawbacks of supporting categorization through props or through folder structure
• Implement a way to support supplementary information on specific C# methods via markdown content files

Additional context
Assigning myself as this requires changes to the docs core repo