From 07b5a5d6c3e6bd263673cb407c87489077fdbe96 Mon Sep 17 00:00:00 2001 From: Ik <113038466+Ik1497@users.noreply.github.com> Date: Sun, 29 Oct 2023 16:52:42 +0100 Subject: [PATCH 1/5] Add multiple things (see commits) (#3) * Add patreon triggers * Add Commands triggers * Add File/Folder watcher triggers * Remove old page from file/folder watcher triggers * Add Hotkeys triggers * Remove old hotkeys page * Fix to command websocket events * Fix command triggers * Add quote triggers * Add Voice Control triggers * Remove old triggers files --- .../Core/Commands/Command-Cooldown.md | 4 ++ .../Core/Commands/Command-Triggered.md | 3 ++ .../3.api/2.triggers/3.general/Core/Quote.md | 18 -------- .../2.triggers/3.general/Core/Quote/Added.md | 28 +++--------- .../2.triggers/3.general/Core/Quote/Show.md | 28 +++--------- .../3.general/Core/Voice-Control.md | 18 -------- .../3.general/Core/Voice-Control/Command.md | 34 ++++---------- .../4.servers/1.websocket/1.events/command.md | 44 ++----------------- .../4.servers/1.websocket/1.events/twitch.md | 17 +++++++ 9 files changed, 51 insertions(+), 143 deletions(-) delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Quote.md delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Voice-Control.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md b/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md index 4497f2bc..d92deb8e 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md @@ -1,4 +1,8 @@ # Command Cooldown + +Command Cooldown trigger. + +## Details This event triggers when a command is used whilst it is in cooldown. ## Parameters diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md b/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md index f4c0319d..5a9c2a5e 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md @@ -1,4 +1,7 @@ # Command Triggered +Command Triggered trigger. + +## Details This event triggers when a command is triggered. ## Parameters diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Quote.md b/streamerbot/3.api/2.triggers/3.general/Core/Quote.md deleted file mode 100755 index d78eb518..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Quote.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Quote -description: Core Triggers Reference -published: true -date: 2023-03-15T22:22:37.345Z -tags: -editor: markdown -dateCreated: 2023-03-15T22:18:02.361Z ---- - -- [ **Added *When a quote is added***](/Triggers/Core/Quote/Added) -- [ **Show *When a quote gets shown***](/Triggers/Core/Quote/Show) -{.btn-grid .my-5} - ---- - -- [**Triggers Reference *Go Back***](/Triggers) -{.btn-grid .my-5} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md b/streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md index eb9fa5b0..5e85ff4e 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md @@ -1,30 +1,16 @@ ---- -title: Added -description: Quote Triggers Reference -published: true -date: 2023-04-17T22:58:57.074Z -tags: -editor: markdown -dateCreated: 2023-03-15T22:21:34.997Z ---- +# Added +Quote added trigger. -## Overview -The Quote Added trigger gets triggered when you add a quote. - -For a detailed guide on how Quotes work in Streamer.bot see [this page](/Settings/Quote). +## Details +This event triggers when a quote is added. ## Variables +:variables-description + Name | Description ----:|:------------ `quote` | The quote content `quoteID` | The numeric quote id `quoteUser` | The user that added the quote, `quoteGame` | The game the broadcaster was playing at the time -`quoteTime` | The date it was logged -{.vars-table} - ---- - -- [**Quote Triggers Reference *Go Back***](/Triggers/Core/Quote) -- [ **Show *Next Up***](/Triggers/Core/Quote/Show) -{.btn-grid .my-5} \ No newline at end of file +`quoteTime` | The date it was logged \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md b/streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md index 28b45f23..ea461477 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md @@ -1,30 +1,16 @@ ---- -title: Show -description: Quote Triggers Reference -published: true -date: 2023-04-17T22:59:07.001Z -tags: -editor: markdown -dateCreated: 2023-03-15T22:22:17.470Z ---- +# Show +Quote show trigger. -## Overview -The Quote Show trigger gets triggered when you show a quote. - -For a detailed guide on how Quotes work in Streamer.bot see [this page](/Settings/Quote). +## Details +This event triggers when you show a quote. ## Variables +:variables-description + Name | Description ----:|:------------ `quote` | The quote content `quoteID` | The numeric quote id `quoteUser` | The user that added the quote, `quoteGame` | The game the broadcaster was playing at the time -`quoteTime` | The date it was logged -{.vars-table} - ---- - -- [**Quote Triggers Reference *Go Back***](/Triggers/Core/Quote) -- [ **Added *Mext Up***](/Triggers/Core/Quote/Added) -{.btn-grid .my-5} \ No newline at end of file +`quoteTime` | The date it was logged \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control.md b/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control.md deleted file mode 100755 index 3e7890c8..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Voice Control -description: Core Triggers Reference -published: true -date: 2023-03-14T22:34:38.993Z -tags: -editor: markdown -dateCreated: 2023-03-14T22:03:49.961Z ---- - -- [ **Command *When a speak command gets triggered***](/Triggers/Core/Voice-Control/Command) -- [ **Dictation *When you say something***](/Triggers/Core/Voice-Control/Dictation) -{.btn-grid .my-5} - ---- - -- [**Triggers Reference *Go Back***](/Triggers) -{.btn-grid .my-5} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md b/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md index f77b33aa..3bf89cf9 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md @@ -1,23 +1,16 @@ ---- -title: Command -description: Voice Control Triggers Reference -published: true -date: 2023-03-18T01:22:01.381Z -tags: -editor: markdown -dateCreated: 2023-03-14T22:34:14.348Z ---- +# Command +Voice Control Command trigger. -## Overview -This triggers when a voice control command is successfully used. +## Details +This event triggers when a voice control command is used. -For a detailed guide on how Voice Control works in Streamer.bot see [this page](/Voice-Control). - -## Configuration -### Voice Control +## Parameters +### `Voice Control` Select any or a specific command from the Voice Control tab. ## Variables +:variables-description + Name | Description ----:|:------------ `spokenText` | The full spoken phrase detected, *including the trigger phrase* @@ -27,13 +20,4 @@ Name | Description `altPhraseConfidence#` | The confidence of an alternative phrase `altPhraseConfidencePercent#` | The percentage of the confidence from an alternative phrase `spokenTextInput` | Detected spoken phrase with trigger command stripped
(Only works with `Start` based commands) -`spokenCommand` | Detected Trigger command -{.vars-table} - -> Change the `#` to a number from 0 to the end of the alt phrases. So e.g. `%altPhraseText0%`, `%altPhraseText1%`, `%altPhraseText2%` -{.is-info} - ---- - -- [**Voice Control Triggers Reference *Go Back***](/Triggers/Core/Voice-Control) -{.btn-grid .my-5} \ No newline at end of file +`spokenCommand` | Detected Trigger command \ No newline at end of file diff --git a/streamerbot/3.api/4.servers/1.websocket/1.events/command.md b/streamerbot/3.api/4.servers/1.websocket/1.events/command.md index 807be014..17ff6cf8 100644 --- a/streamerbot/3.api/4.servers/1.websocket/1.events/command.md +++ b/streamerbot/3.api/4.servers/1.websocket/1.events/command.md @@ -14,17 +14,15 @@ You can enable `Command` events with this [Subscribe](/api/servers/websocket/req "id": "my-subscribe-id", "events": { "Command": [ - "Message", - "Whisper", - "BotWhisper", - "MessageCooldown", + "Triggered", + "Cooldown", ] }, } ``` ## Events -### `Message` +### `Triggered` ```json { "command": "!bots", @@ -41,41 +39,7 @@ You can enable `Command` events with this [Subscribe](/api/servers/websocket/req } ``` -### `Whisper` -```json -{ - "command": "!bots", - "counter": 1, - "userCounter": 1, - "message": "", - "user": { - "id": 00000000, - "login": "", - "display_name": "", - "subscribed": true, - "role": 4 - } -} -``` - -### `BotWhisper` -```json -{ - "command": "!bots", - "counter": 1, - "userCounter": 1, - "message": "", - "user": { - "id": 00000000, - "login": "", - "display_name": "", - "subscribed": true, - "role": 4 - } -} -``` - -### `MessageCooldown` +### `Cooldown` ```json { "command": "!bots", diff --git a/streamerbot/3.api/4.servers/1.websocket/1.events/twitch.md b/streamerbot/3.api/4.servers/1.websocket/1.events/twitch.md index ecd0c657..50e6404e 100644 --- a/streamerbot/3.api/4.servers/1.websocket/1.events/twitch.md +++ b/streamerbot/3.api/4.servers/1.websocket/1.events/twitch.md @@ -95,6 +95,23 @@ Reference of all Twitch events emitted by the WebSocket Server. } ``` +### BotWhisper +```json [BotWhisper] +{ + "command": "!bots", + "counter": 1, + "userCounter": 1, + "message": "", + "user": { + "id": 00000000, + "login": "", + "display_name": "", + "subscribed": true, + "role": 4 + } +} +``` + ## First Words ```json [FirstWord] { From 9665144891ee8c14e49f660da5d1d6c8c9b0b17c Mon Sep 17 00:00:00 2001 From: GoWMan813 <33267417+GoWMan813@users.noreply.github.com> Date: Sun, 29 Oct 2023 12:40:00 -0500 Subject: [PATCH 2/5] Removed more tabsets (#4) * Update raw.md Removed straggling .{tabset} * Update streamelements.md Removed straggling .{tabset} * Update streamlabs.md Removed straggling .{tabset} and unneeded description to keep docs uniform. --- .../3.api/4.servers/1.websocket/1.events/streamelements.md | 4 ++-- .../3.api/4.servers/1.websocket/1.events/streamlabs.md | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/streamerbot/3.api/4.servers/1.websocket/1.events/streamelements.md b/streamerbot/3.api/4.servers/1.websocket/1.events/streamelements.md index 57b0eda7..654fe1b5 100644 --- a/streamerbot/3.api/4.servers/1.websocket/1.events/streamelements.md +++ b/streamerbot/3.api/4.servers/1.websocket/1.events/streamelements.md @@ -1,5 +1,5 @@ # StreamElements -### Tabs {.tabset} + #### Tip ```json { @@ -10,4 +10,4 @@ "message": "This is a test message", "isTest": false } -``` \ No newline at end of file +``` diff --git a/streamerbot/3.api/4.servers/1.websocket/1.events/streamlabs.md b/streamerbot/3.api/4.servers/1.websocket/1.events/streamlabs.md index dd43cb0d..992e7125 100644 --- a/streamerbot/3.api/4.servers/1.websocket/1.events/streamlabs.md +++ b/streamerbot/3.api/4.servers/1.websocket/1.events/streamlabs.md @@ -1,7 +1,5 @@ # Streamlabs -These are the events that are broadcast from Streamlabs events. -### Tab {.tabset} #### Donation ```json { @@ -22,4 +20,4 @@ These are the events that are broadcast from Streamlabs events. "image": "https://uploads.twitchalerts.com/000/105/166/207/891265-mockup-152840970714082-0.png", "isTest": true } -``` \ No newline at end of file +``` From a83a7806599af91e72633bf2363cb74104519e97 Mon Sep 17 00:00:00 2001 From: GoWMan813 <33267417+GoWMan813@users.noreply.github.com> Date: Sun, 29 Oct 2023 23:20:42 -0500 Subject: [PATCH 3/5] Updated Process and Websocket API docs. (#5) --- .../2.triggers/3.general/Core/Processes.md | 18 ---------- .../Core/Processes/Process-Started.md | 30 ++++++++++++++++ .../Core/Processes/Process-Stopped.md | 30 ++++++++++++++++ .../3.general/Core/Websocket/Client.md | 19 ---------- .../3.general/Core/Websocket/Client/Close.md | 32 ++++++----------- .../Core/Websocket/Client/Message.md | 36 +++++++------------ .../3.general/Core/Websocket/Client/Open.md | 30 ++++++---------- .../3.general/Core/Websocket/Custom-Server.md | 19 ---------- .../Custom-Server-Connection-Closed.md | 32 ++++++----------- .../Custom-Server-Connection-Opened.md | 36 +++++++------------ .../Custom-Server/Custom-Server-Message.md | 36 +++++++------------ 11 files changed, 131 insertions(+), 187 deletions(-) delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Processes.md create mode 100644 streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md create mode 100644 streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client.md delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Processes.md b/streamerbot/3.api/2.triggers/3.general/Core/Processes.md deleted file mode 100755 index c28b5b04..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Processes.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Processes -description: Core Triggers Reference -published: true -date: 2023-06-18T11:25:30.229Z -tags: -editor: markdown -dateCreated: 2023-06-18T11:25:30.229Z ---- - -- [ **Process Started *Listen to when a process is started***](/Triggers/Core/Processes/Process-Started) -- [ **Process Stopped *Listen to when a process is stopped***](/Triggers/Core/Processes/Process-Stopped) -{.btn-grid .my-5} - ---- - -- [**Triggers Reference *Go Back***](/Triggers) -{.btn-grid .my-5} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md b/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md new file mode 100644 index 00000000..164fe00e --- /dev/null +++ b/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md @@ -0,0 +1,30 @@ +# Process Started + +Process Started trigger. + +## Details + +This event triggers when a process is started. + +## Parameters + +### `Name` + +Input the name of the process to watch for. + +::callout{icon=i-mdi-lightbulb color=amber} +Leaving this blank is considered a catch-all and will trigger on ANY process started. +:: + +## Variables + +:variables-description + +Name | Description +----:|:------------ +`name` | Name of the process watched for. +`executable` | Name of the process executable. +`path` | Path to the directory of the process. +`fullPath` | Exact path of the process executable. +`processId` | ID used in Windows for the process. +`parentProcessId` | ID of the program that launched the process. \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md b/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md new file mode 100644 index 00000000..292b7512 --- /dev/null +++ b/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md @@ -0,0 +1,30 @@ +# Process Stopped + +Process Stopped trigger. + +## Details + +This event triggers when a process is stopped. + +## Parameters + +### `Name` + +Input the name of the process to watch for. + +::callout{icon=i-mdi-lightbulb color=amber} +Leaving this blank is considered a catch-all and will trigger on ANY process stopped. +:: + +## Variables + +:variables-description + +Name | Description +----:|:------------ +`name` | Name of the process watched for. +`executable` | Name of the process executable. +`path` | Path to the directory of the process. +`fullPath` | Exact path of the process executable. +`processId` | ID used in Windows for the process. +`parentProcessId` | ID of the program that launched the process. diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client.md deleted file mode 100755 index f9346fbf..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: WebSocket Client -description: Core Websocket Triggers Reference -published: true -date: 2023-03-16T22:10:16.133Z -tags: -editor: markdown -dateCreated: 2023-03-16T21:31:51.362Z ---- - -- [ **Close *Listen to when a websocket client closes***](/Triggers/Core/Websocket/Client/Close) -- [ **Message *Listen to websocket client messages***](/Triggers/Core/Websocket/Client/Message) -- [ **Open *Listen to when a websocket client opens***](/Triggers/Core/Websocket/Client/Open) -{.btn-grid .my-5} - ---- - -- [**Triggers Reference *Go Back***](/Triggers) -{.btn-grid .my-5} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md index fe85bb8a..0645c7a3 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md @@ -1,23 +1,19 @@ ---- -title: Close -description: WebSocket Client Triggers Reference -published: true -date: 2023-03-16T22:04:01.082Z -tags: -editor: markdown -dateCreated: 2023-03-16T21:46:47.174Z ---- - -## Overview +# Websocket Client Close + +Websocket Client Close trigger. + +## Details + The Websocket Client Close Trigger is used for when any or a selected client closes. -For a detailed guide about the Websocket Client see [this page](/Servers-Clients/WebSocket-Clients). +## Parameters -## Configuration ### Client -Select any or a specific websocket client + +Select any or a specific websocket client. ## Variables + Name | Description ----:|:------------ `wsIdx` | The 0-based id of this websocket e.g. `0`, `1`, `2`, etc. @@ -28,10 +24,4 @@ Name | Description `wsHost` | The host of this websocket client e.g. `127.0.0.1` `wsPort` | The port of this websocket client e.g. `8080` `wsPath` | The path of this websocket client e.g.`/` -`wsQuery` | The query of this websocket client e.g.`?key=value` - ---- - -- [**Websocket Client Triggers Reference *Go Back***](/Triggers/Core/Websocket/Client) -- [ **Message *Next Up***](/Triggers/Core/Websocket/Client/Message) -{.btn-grid .my-5} \ No newline at end of file +`wsQuery` | The query of this websocket client e.g.`?key=value` \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md index 0ac60793..a4b226b3 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md @@ -1,23 +1,19 @@ ---- -title: Message -description: WebSocket Client Triggers Reference -published: true -date: 2023-03-16T22:04:07.074Z -tags: -editor: markdown -dateCreated: 2023-03-16T22:03:09.481Z ---- - -## Overview -The Websocket Client Open Trigger is used for when any or a selected client opens. - -For a detailed guide about the Websocket Client see [this page](/Servers-Clients/WebSocket-Clients). - -## Configuration +# Websocket Client Message + +Websocket Client Message trigger. + +## Details + +The Websocket Client Message Trigger is used for when any or a selected client data is detected. + +## Parameters + ### Client + Select any or a specific websocket client ## Variables + Name | Description ----:|:------------ `wsIdx` | The 0-based id of this websocket e.g. `0`, `1`, `2`, etc. @@ -29,10 +25,4 @@ Name | Description `wsPort` | The port of this websocket client e.g. `8080` `wsPath` | The path of this websocket client e.g.`/` `wsQuery` | The query of this websocket client e.g.`?key=value` -`message` | {"timeStamp":"2023-03-16T22:58:28.3298+01:00","event":{"source":"HotKey","type":"Press"},"data":{"_85lbxopeOGvkNXq7iRgrjS6tpjj":1,"_hdhxue62iGbvG5rnMWU0dxGe29p":96}} - ---- - -- [**Websocket Client Triggers Reference *Go Back***](/Triggers/Core/Websocket/Client) -- [ **Open *Next Up***](/Triggers/Core/Websocket/Client/Open) -{.btn-grid .my-5} \ No newline at end of file +`message` | {"timeStamp":"2023-03-16T22:58:28.3298+01:00","event":{"source":"HotKey","type":"Press"},"data":{"_85lbxopeOGvkNXq7iRgrjS6tpjj":1,"_hdhxue62iGbvG5rnMWU0dxGe29p":96}} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md index 3e88e1ef..6fe17619 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md @@ -1,23 +1,19 @@ ---- -title: Open -description: WebSocket Client Triggers Reference -published: true -date: 2023-03-16T22:04:13.649Z -tags: -editor: markdown -dateCreated: 2023-03-16T21:42:30.447Z ---- - -## Overview +# Websocket Client Open + +Websocket Client Open trigger. + +## Details + The Websocket Client Open Trigger is used for when any or a selected client opens. -For a detailed guide about the Websocket Client see [this page](/Servers-Clients/WebSocket-Clients). +## Parameters -## Configuration ### Client + Select any or a specific websocket client ## Variables + Name | Description ----:|:------------ `wsIdx` | The 0-based id of this websocket e.g. `0`, `1`, `2`, etc. @@ -28,10 +24,4 @@ Name | Description `wsHost` | The host of this websocket client e.g. `127.0.0.1` `wsPort` | The port of this websocket client e.g. `8080` `wsPath` | The path of this websocket client e.g.`/` -`wsQuery` | The query of this websocket client e.g.`?key=value` - ---- - -- [**Websocket Client Triggers Reference *Go Back***](/Triggers/Core/Websocket/Client) -- [ **Close *Next Up***](/Triggers/Core/Websocket/Client/Close) -{.btn-grid .my-5} \ No newline at end of file +`wsQuery` | The query of this websocket client e.g.`?key=value` \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server.md deleted file mode 100755 index 02022d07..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Websocket Custom Server -description: Core Websocket Triggers Reference -published: true -date: 2023-04-18T00:23:09.645Z -tags: -editor: markdown -dateCreated: 2023-04-17T23:48:40.539Z ---- - -- [ **Custom Server Connection Closed *Listen to when a websocket client closes***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed) -- [ **Custom Server Connection Opened *Listen to when a websocket client opens***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened) -- [ **Custom Server Message *Listen to websocket client messages***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Message) -{.btn-grid .my-5} - ---- - -- [**Triggers Reference *Go Back***](/Triggers) -{.btn-grid .my-5} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md index 604ccbd1..874efb13 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md @@ -1,29 +1,19 @@ ---- -title: Custom Server Connection Closed -description: Websocket Custom Server Reference -published: true -date: 2023-04-18T00:18:43.369Z -tags: -editor: markdown -dateCreated: 2023-04-18T00:17:57.247Z ---- - -## Overview +# Websocket Custom Sever Connection Closed + +Websocket Custom Sever Connection Closed trigger. + +## Details + This triggers when a client disconnects to the custom websocket server. -For a detailed guide about Websocket Servers see [this page](/Servers-Clients/WebSocket-Servers). +## Parameters -## Configuration ### Server -Select any or a specific websocket server + +Select any or a specific websocket server. ## Variables + Name | Description ----:|:------------ -`sessionId` | The session id of the client - ---- - -- [**Websocket Custom Server Triggers Reference *Go Back***](/Triggers/Core/Websocket/Custom-Server) -- [ **Custom Server Connection Opened *Up Next***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened) -{.btn-grid .my-5} \ No newline at end of file +`sessionId` | The session id of the client. \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md index ca931827..ea78828a 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md @@ -1,32 +1,22 @@ ---- -title: Custom Server Connection Opened -description: Websocket Custom Server Reference -published: true -date: 2023-04-18T00:23:22.662Z -tags: -editor: markdown -dateCreated: 2023-04-18T00:15:36.923Z ---- - -## Overview +# Websocket Custom Sever Connection Opened + +Websocket Custom Sever Connection Opened trigger. + +## Details + This triggers when a client connects to the custom websocket server. -For a detailed guide about Websocket Servers see [this page](/Servers-Clients/WebSocket-Servers). +## Parameters -## Configuration ### Server -Select any or a specific websocket server + +Select any or a specific websocket server. ## Variables + Name | Description ----:|:------------ `wssIdx` | The 0-based id of this websocket server e.g. `0`, `1`, `2`, etc. -`wssId` | The UUID of this websocket server -`ip` | The ip of this websocket serber e.g. `127.0.0.1` -`sessionId` | The session id of the client - ---- - -- [**Websocket Custom Server Triggers Reference *Go Back***](/Triggers/Core/Websocket/Custom-Server) -- [ **Custom Server Message *Up Next***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Message) -{.btn-grid .my-5} \ No newline at end of file +`wssId` | The UUID of this websocket server. +`ip` | The ip of this websocket server e.g. `127.0.0.1` +`sessionId` | The session id of the client. \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md index c150a41b..c9e0fe11 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md +++ b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md @@ -1,33 +1,23 @@ ---- -title: Custom Server Message -description: Websocket Custom Server Reference -published: true -date: 2023-04-18T00:22:45.464Z -tags: -editor: markdown -dateCreated: 2023-04-18T00:22:43.500Z ---- - -## Overview +# Websocket Custom Sever Message + +Websocket Custom Sever Message. + +## Details + This triggers when a client sends a message the custom websocket server. -For a detailed guide about Websocket Servers see [this page](/Servers-Clients/WebSocket-Servers). +## Parameters -## Configuration ### Server + Select any or a specific websocket server ## Variables + Name | Description ----:|:------------ `wssIdx` | The 0-based id of this websocket server e.g. `0`, `1`, `2`, etc. -`wssId` | The UUID of this websocket server -`ip` | The ip of this websocket serber e.g. `127.0.0.1` -`sessionId` | The session id of the client -`data` | The received data from the client - ---- - -- [**Websocket Custom Server Triggers Reference *Go Back***](/Triggers/Core/Websocket/Custom-Server) -- [ **Custom Server Connection Closed *Up Next***](/Triggers/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed) -{.btn-grid .my-5} \ No newline at end of file +`wssId` | The UUID of this websocket server. +`ip` | The ip of this websocket server e.g. `127.0.0.1` +`sessionId` | The session id of the client. +`data` | The received data from the client. \ No newline at end of file From d717fc31a4b97de5c0c4ecbe914cc61b8ab61869 Mon Sep 17 00:00:00 2001 From: Whipstickgostop <8366326+Whipstickgostop@users.noreply.github.com> Date: Mon, 30 Oct 2023 01:21:04 -0400 Subject: [PATCH 4/5] adjust casing, reformat --- .../Custom-Server-Connection-Closed.md | 19 ------------------- .../3.general/{Core => core}/_dir.yml | 0 .../commands/cooldown.md} | 6 +----- .../commands/triggered.md} | 9 +++------ .../file-folder-watcher/changed.md} | 0 .../file-folder-watcher/created.md} | 0 .../file-folder-watcher/deleted.md} | 0 .../file-folder-watcher/renamed.md} | 0 .../hot-keys/press.md} | 0 .../processes/started.md} | 0 .../processes/stopped.md} | 0 .../Quote/Added.md => core/quotes/added.md} | 0 .../Quote/Show.md => core/quotes/show.md} | 0 .../timed-actions.md} | 0 .../voice-control/command.md} | 0 .../websocket-client/close.md} | 13 ++++--------- .../websocket-client/message.md} | 13 ++++--------- .../Open.md => core/websocket-client/open.md} | 8 ++------ .../3.general/core/websocket-server/close.md | 14 ++++++++++++++ .../websocket-server/message.md} | 13 ++++--------- .../websocket-server/open.md} | 13 ++++--------- 21 files changed, 36 insertions(+), 72 deletions(-) delete mode 100755 streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md rename streamerbot/3.api/2.triggers/3.general/{Core => core}/_dir.yml (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Commands/Command-Cooldown.md => core/commands/cooldown.md} (87%) rename streamerbot/3.api/2.triggers/3.general/{Core/Commands/Command-Triggered.md => core/commands/triggered.md} (87%) rename streamerbot/3.api/2.triggers/3.general/{Core/File-Folder-Watcher/Changed.md => core/file-folder-watcher/changed.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/File-Folder-Watcher/Created.md => core/file-folder-watcher/created.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/File-Folder-Watcher/Deleted.md => core/file-folder-watcher/deleted.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/File-Folder-Watcher/Renamed.md => core/file-folder-watcher/renamed.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Hot-Keys/HotKey-Press.md => core/hot-keys/press.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Processes/Process-Started.md => core/processes/started.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Processes/Process-Stopped.md => core/processes/stopped.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Quote/Added.md => core/quotes/added.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Quote/Show.md => core/quotes/show.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Timed-Actions.md => core/timed-actions.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Voice-Control/Command.md => core/voice-control/command.md} (100%) rename streamerbot/3.api/2.triggers/3.general/{Core/Websocket/Client/Close.md => core/websocket-client/close.md} (79%) rename streamerbot/3.api/2.triggers/3.general/{Core/Websocket/Client/Message.md => core/websocket-client/message.md} (67%) rename streamerbot/3.api/2.triggers/3.general/{Core/Websocket/Client/Open.md => core/websocket-client/open.md} (84%) create mode 100755 streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md rename streamerbot/3.api/2.triggers/3.general/{Core/Websocket/Custom-Server/Custom-Server-Message.md => core/websocket-server/message.md} (69%) rename streamerbot/3.api/2.triggers/3.general/{Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md => core/websocket-server/open.md} (63%) diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md b/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md deleted file mode 100755 index 874efb13..00000000 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Closed.md +++ /dev/null @@ -1,19 +0,0 @@ -# Websocket Custom Sever Connection Closed - -Websocket Custom Sever Connection Closed trigger. - -## Details - -This triggers when a client disconnects to the custom websocket server. - -## Parameters - -### Server - -Select any or a specific websocket server. - -## Variables - -Name | Description -----:|:------------ -`sessionId` | The session id of the client. \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/_dir.yml b/streamerbot/3.api/2.triggers/3.general/core/_dir.yml similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/_dir.yml rename to streamerbot/3.api/2.triggers/3.general/core/_dir.yml diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md b/streamerbot/3.api/2.triggers/3.general/core/commands/cooldown.md similarity index 87% rename from streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md rename to streamerbot/3.api/2.triggers/3.general/core/commands/cooldown.md index d92deb8e..c3988d1c 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Cooldown.md +++ b/streamerbot/3.api/2.triggers/3.general/core/commands/cooldown.md @@ -1,9 +1,5 @@ # Command Cooldown - -Command Cooldown trigger. - -## Details -This event triggers when a command is used whilst it is in cooldown. +Triggered when a command has been triggered with an active cooldown ## Parameters ### `Commands` diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md b/streamerbot/3.api/2.triggers/3.general/core/commands/triggered.md similarity index 87% rename from streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md rename to streamerbot/3.api/2.triggers/3.general/core/commands/triggered.md index 5a9c2a5e..04dace7e 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Commands/Command-Triggered.md +++ b/streamerbot/3.api/2.triggers/3.general/core/commands/triggered.md @@ -1,8 +1,5 @@ # Command Triggered -Command Triggered trigger. - -## Details -This event triggers when a command is triggered. +Execute an action when a command has been triggered ## Parameters ### `Commands` @@ -18,14 +15,14 @@ Name | Description `commandSource` | The command source
`twitch`/`youtube` `commandType` | The type of the command e.g. `message` `msgId` | The unique message id for this message -`rawInput` | The message entered, if the command was a Starts With, this will be removed +`rawInput` | The message entered, if the command was a Starts With, this will be removed `rawInputEscaped` | The message escaped `rawInputUrlEncoded` | The message URL encoded `input#` | The # word of the message entered, spaces are delimiters and variable names are 0 indexed, so `input0` would give the first word, `input1` would give the second, and so on `inputEscaped#` | The indexed word escaped `inputUrlEncoded#` | The indexed word URL encoded `role` | What role the user has `(1-4)`
4=`Broadcaster` 3=`Mod` 2=`VIP` 1=`Viewer` -`counter` | A running total of how many times a command has been run since application launch (if +`counter` | A running total of how many times a command has been run since application launch (if :variables{name=TwitchUser disclosure} :variables{name=TwitchBroadcaster disclosure} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Changed.md b/streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/changed.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Changed.md rename to streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/changed.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Created.md b/streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/created.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Created.md rename to streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/created.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Deleted.md b/streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/deleted.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Deleted.md rename to streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/deleted.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Renamed.md b/streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/renamed.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/File-Folder-Watcher/Renamed.md rename to streamerbot/3.api/2.triggers/3.general/core/file-folder-watcher/renamed.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Hot-Keys/HotKey-Press.md b/streamerbot/3.api/2.triggers/3.general/core/hot-keys/press.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Hot-Keys/HotKey-Press.md rename to streamerbot/3.api/2.triggers/3.general/core/hot-keys/press.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md b/streamerbot/3.api/2.triggers/3.general/core/processes/started.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Started.md rename to streamerbot/3.api/2.triggers/3.general/core/processes/started.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md b/streamerbot/3.api/2.triggers/3.general/core/processes/stopped.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Processes/Process-Stopped.md rename to streamerbot/3.api/2.triggers/3.general/core/processes/stopped.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md b/streamerbot/3.api/2.triggers/3.general/core/quotes/added.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Quote/Added.md rename to streamerbot/3.api/2.triggers/3.general/core/quotes/added.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md b/streamerbot/3.api/2.triggers/3.general/core/quotes/show.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Quote/Show.md rename to streamerbot/3.api/2.triggers/3.general/core/quotes/show.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Timed-Actions.md b/streamerbot/3.api/2.triggers/3.general/core/timed-actions.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Timed-Actions.md rename to streamerbot/3.api/2.triggers/3.general/core/timed-actions.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md b/streamerbot/3.api/2.triggers/3.general/core/voice-control/command.md similarity index 100% rename from streamerbot/3.api/2.triggers/3.general/Core/Voice-Control/Command.md rename to streamerbot/3.api/2.triggers/3.general/core/voice-control/command.md diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md similarity index 79% rename from streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md rename to streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md index 0645c7a3..eaffd688 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Close.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md @@ -1,18 +1,13 @@ -# Websocket Client Close - -Websocket Client Close trigger. - -## Details - -The Websocket Client Close Trigger is used for when any or a selected client closes. +# WebSocket Client Closed +Triggered when a configured WebSocket client connection is closed ## Parameters -### Client - +### `Client` Select any or a specific websocket client. ## Variables +:variables-description Name | Description ----:|:------------ diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md similarity index 67% rename from streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md rename to streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md index a4b226b3..be1ec11d 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Message.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md @@ -1,18 +1,13 @@ # Websocket Client Message - -Websocket Client Message trigger. - -## Details - -The Websocket Client Message Trigger is used for when any or a selected client data is detected. +Triggered when data is received by a configured WebSocket client ## Parameters -### Client - +### `Client` Select any or a specific websocket client ## Variables +:variables-description Name | Description ----:|:------------ @@ -25,4 +20,4 @@ Name | Description `wsPort` | The port of this websocket client e.g. `8080` `wsPath` | The path of this websocket client e.g.`/` `wsQuery` | The query of this websocket client e.g.`?key=value` -`message` | {"timeStamp":"2023-03-16T22:58:28.3298+01:00","event":{"source":"HotKey","type":"Press"},"data":{"_85lbxopeOGvkNXq7iRgrjS6tpjj":1,"_hdhxue62iGbvG5rnMWU0dxGe29p":96}} \ No newline at end of file +`message` | `{"timeStamp":"2023-03-16T22:58:28.3298+01:00","event":{"source":"HotKey","type":"Press"},"data":{"_85lbxopeOGvkNXq7iRgrjS6tpjj":1,"_hdhxue62iGbvG5rnMWU0dxGe29p":96}}`{lang=json} \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md similarity index 84% rename from streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md rename to streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md index 6fe17619..75bdb794 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Client/Open.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md @@ -1,10 +1,5 @@ # Websocket Client Open - -Websocket Client Open trigger. - -## Details - -The Websocket Client Open Trigger is used for when any or a selected client opens. +Triggered when a configured WebSocket client connection is opened ## Parameters @@ -13,6 +8,7 @@ The Websocket Client Open Trigger is used for when any or a selected client open Select any or a specific websocket client ## Variables +:variables-description Name | Description ----:|:------------ diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md new file mode 100755 index 00000000..e5427bae --- /dev/null +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md @@ -0,0 +1,14 @@ +# WebSocket Custom Sever Connection Closed +Triggered when a client disconnects from a custom WebSocket server + +## Parameters + +### `Server` +Select any or a specific websocket server. + +## Variables +:variables-description + +Name | Description +----:|:------------ +`sessionId` | The session id of the client. \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md similarity index 69% rename from streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md rename to streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md index c9e0fe11..f1c014b1 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Message.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md @@ -1,18 +1,13 @@ -# Websocket Custom Sever Message - -Websocket Custom Sever Message. - -## Details - -This triggers when a client sends a message the custom websocket server. +# WebSocket Custom Sever Message +Triggered when a client sends a message to a custom WebSocket server ## Parameters -### Server - +### `Server` Select any or a specific websocket server ## Variables +:variables-description Name | Description ----:|:------------ diff --git a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md similarity index 63% rename from streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md rename to streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md index ea78828a..8930d33f 100755 --- a/streamerbot/3.api/2.triggers/3.general/Core/Websocket/Custom-Server/Custom-Server-Connection-Opened.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md @@ -1,18 +1,13 @@ -# Websocket Custom Sever Connection Opened - -Websocket Custom Sever Connection Opened trigger. - -## Details - -This triggers when a client connects to the custom websocket server. +# WebSocket Custom Sever Connection Opened +Triggered when a client connects to a custom WebSocket server ## Parameters -### Server - +### `Server` Select any or a specific websocket server. ## Variables +:variables-description Name | Description ----:|:------------ From 1f09a13fa83a03a548eab33fd5648ca8d8aa7e3d Mon Sep 17 00:00:00 2001 From: Whipstickgostop <8366326+Whipstickgostop@users.noreply.github.com> Date: Mon, 30 Oct 2023 02:10:02 -0400 Subject: [PATCH 5/5] cleanup nav --- .../2.triggers/3.general/core/websocket-client/close.md | 4 ++++ .../2.triggers/3.general/core/websocket-client/message.md | 4 ++++ .../2.triggers/3.general/core/websocket-client/open.md | 4 ++++ .../2.triggers/3.general/core/websocket-server/close.md | 6 +++++- .../2.triggers/3.general/core/websocket-server/message.md | 6 +++++- .../2.triggers/3.general/core/websocket-server/open.md | 6 +++++- 6 files changed, 27 insertions(+), 3 deletions(-) diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md index eaffd688..e0d14e10 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/close.md @@ -1,3 +1,7 @@ +--- +navigation.title: Connection Closed +--- + # WebSocket Client Closed Triggered when a configured WebSocket client connection is closed diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md index be1ec11d..75ac01fe 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/message.md @@ -1,3 +1,7 @@ +--- +navigation.title: Message +--- + # Websocket Client Message Triggered when data is received by a configured WebSocket client diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md index 75bdb794..564b9ce5 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-client/open.md @@ -1,3 +1,7 @@ +--- +navigation.title: Connection Opened +--- + # Websocket Client Open Triggered when a configured WebSocket client connection is opened diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md index e5427bae..601c57e6 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/close.md @@ -1,4 +1,8 @@ -# WebSocket Custom Sever Connection Closed +--- +navigation.title: Connection Closed +--- + +# WebSocket Custom Server Connection Closed Triggered when a client disconnects from a custom WebSocket server ## Parameters diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md index f1c014b1..c0025910 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/message.md @@ -1,4 +1,8 @@ -# WebSocket Custom Sever Message +--- +navigation.title: Message +--- + +# WebSocket Custom Server Message Triggered when a client sends a message to a custom WebSocket server ## Parameters diff --git a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md index 8930d33f..d877a7c1 100755 --- a/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md +++ b/streamerbot/3.api/2.triggers/3.general/core/websocket-server/open.md @@ -1,4 +1,8 @@ -# WebSocket Custom Sever Connection Opened +--- +navigation.title: Connection Opened +--- + +# WebSocket Custom Server Connection Opened Triggered when a client connects to a custom WebSocket server ## Parameters