Merge remote-tracking branch 'refs/remotes/origin/latest'

patch notes.txt

@@ -1,41 +1,111 @@
 ====================================
-     SAMMI 2023.3.0 (October 2023)
+     SAMMI 2023.3.1 (December 2023)
 ====================================
 
 [SAMMI Core]
 -------------------------------------
 New Features:
-- Added new Command: "Twitch: Reply to Message" - Reply to Twitch messages directly instead of just sending chat messages [Chrizzz]
-- New Integration: Pulsoid - This integration sends your heartrate to SAMMI as long as you use any pulsoid device (will be available soon) [Chrizzz]
-- Added new "Alert Log" function - You can activate it in the settings menu for SAMMI to document all yellow alerts in a logfile (alert.log) [Chrizzz]
-- Added the deck names to the variable viewer for all persistent buttons to easily find which deck your buttons belong to [Chrizzz & Silverlink]
-- Added a "RefreshBrowserSource" template to the "Send OBS Request" templates for OBSWS5 [Chrizzz]
-- Added "fullFPS" key you can set to "1" in settings.ini, to keep full FPS when SAMMI is not in focus [Christina]
+- Added new Command: "Get Button Color" - Fetches the button color [Chrizzz]
+- Added new Command: "Get Button Text" - Fetches the text of a button  [Chrizzz]
+- Added new DEV mode command: "Get Instance ID" - Fetches the instance ID of the current button execution [Chrizzz]
+- For hotkey button triggers, Trigger Pull Data command now returns the hotkey and its modifiers that triggered the button [Christina]
+- Added Pulsoid Extension Triggers which let you filter the Heartrate directly inside the trigger [Chrizzz]
+- Added instance_id and button_id to extension trigger pull values [Chrizzz]
+- Added 'Edit' button in the Variable Viewer (when inside a button). This enables opening the Edit Commands Window for that specific button [Christina]
+- Local API now accepts `all` as variable name for `getVariable` request, allowing you to grab the whole button object [Christina]
 
+Improvements:
+- Updated the "Send OBS Request" command to add all missing requests as templates. There are now some templates for commands already in SAMMI Core. This gives the ability to recieve more verbose information for already existing OBS commands. [Landie]
+- If the default Bridge port is not available (e.g. SAMMI crashed and Windows assumes the port is still in use), SAMMI will use a backup port instead (no user action required) [Christina]
+- Optimized Panel protocol; connect and disconnect messages now accurately display the Panel Name [Christina]
+- "Twitch Extra Edit Reward" Login name can be left empty and it will default to your Streamer Account [Chrizzz]
+- The following commands have been upgraded to natively handle objects/arrays (eliminating the need for the Stringify Object/Array command): [Christina]
+  - Set Local Variable, Set Button Variable, Set Button instance Variable, Set Global Variable
+  - Set Object Variable
+  - Array Insert, Array Replace
+  - Note: This implementation was intricate; please report any inconsistencies
+  - IMPORTANT: The Bridge and Local API commands are not yet upgraded to support this feature
+- Improved OBS protocol to account for changes introduced in OBS 30.0, such as correctly setting `connected` variable when OBS is ready to accept requests, or retrying requests when OBS is too busy to respond [Christina]
+- Changed how Deck thumbnails are created - they should now be automatically created by simply entering the deck [Christina]
+
+UI Changes:
+
+Removed Features:
+- Removed support for outdated SAMMI Deck and LioranBoard 2 Stream Deck (including the APK) [Christina]
+  - Please proceed to use SAMMI Panel, or one of the other 3rd party alternatives (Deck Hopper, DeckMate)
+- Removed SAMMI Deck Connected/Disconnected trigger [Christina]
+- Removed global variables `deck_connected` and `deck_version` [Christina]
+
+Bug Fixes:
+- Fixed follower alerts not triggering by adding Eventsub [Christina]
+  - Due to SAMMI using Eventsub for Follower Alerts now, you can only have one Twitch account listening to Follower Alerts 
+    - Navigate to SAMMI Core > Twitch Accounts > Check "New Follows" under "Listen For" section only for one account > Disconnect and Connect to Twitch again
+- Button IDs now get properly duplicated when using Duplicate Deck, with correct payload being sent to SAMMI Panel [Christina]
+- Resolved an issue in Mix It Up: Get Commands command, where now all commands are returned (increased limit to 1000) [Christina]
+- Addressed a minor memory leak when saving a button [Christina]
+- Fixed a memory leak during Panel connection [Christina]
+- Fixed a bug with "Twitch Extra Edit Reward" where Cooldowns and Limits weren't updating correctly [Chrizzz]
+- Resolved a critical issue in the "Array: Pull" and "Array: Remove" commands, which previously led to the destruction of internal structures when used on arrays that had already been deleted. This might have also been a factor in deck/button corruption [Christina].
+  - IMPORTANT: Users who have been utilizing arrays by reference (displayed as numbers in variable viewers) will experience a significant change, as such usage was not originally intended.
+- Fixed a bug where an extension file would be deleted from bridge/extensions/installed folder if it was selected to be installed again [Christina]
+
+
+Known Bugs:
+
+[SAMMI Bridge]
+-------------------------------------
+New Features:
 
 Improvements:
-- Rewrote the "Twitch: Get Latest Followers" and "Twitch: Get Follower Count" command to use the new API endpoint to make them work again [Chrizzz]
-- Renamed the "error_log.txt" file to "error.log" [Chrizzz]
-- Whenever SAMMI shuts down or crashes, all active socket connections (e.g. Bridge, Panel, Twitch) are now forcibly closed. This ensures SAMMI doesn't occupy ports unnecessarily, which sometimes needed a complete system reboot. [Christina]
-- When the "Trigger Button" command is used, the "Trigger Pull Data" command inside the button which got triggered can now fetch the Instance ID of the originating button. This allows you to set variables in the originating button even if it's not persistent. [Christina]
+- If connection to SAMMI fails, Bridge attempts to use a backup port instead (e.g. SAMMI was not able to establish a websocket server on the default port, and is using a backup port) [Christina]
+- SAMMI.getVariable now accepts `all` as variable name, allowing you to grab the whole button object [Christina]
 
 UI Changes:
-- Removed beta tags in the settings menu [Chrizzz]
 
 Removed Features:
 
+Bug Fixes:
+
+Known Bugs:
+
+[SAMMI Voice]
+-------------------------------------
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
 
 Bug Fixes:
-- Fixed Local API Set Variable endpoint where setting a variable to a number did not properly work [Christina]
-- Fixed some command error alerts missing information [Christina]
-- Fixed various crashes related to sockets, checkboxes, closing Twitch connection window, Twitch API command errors, installing extensions and more [Christina]
 
+Known Bugs:
 
-[SAMMI Bridge]
+[SAMMI Panel]
 -------------------------------------
-New Features: 
-- Added SAMMI.loadIni() function to load text/number from ini file directly from Bridge [Christina]
-- Added SAMMI.saveIni() function to save text/number to ini file directly from Bridge [Christina]
-- Added SAMMI.httpRequest() to make an API call directly from SAMMI (to avoid browser CORS errors) [Christina]
-- Added SAMMI.openURL() to open a URL in a default browser directly from SAMMI (rather than opening it in OBS if Bridge is docked) [Christina]
-- Added SAMMI.editButton() to quickly navigate to the selected button's edit commands screen window in SAMMI Core directly from Bridge. Highly experimental. [Christina]
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
+
+Bug Fixes:
+
+Known Bugs:
+
+[SAMMI Updater]
+-------------------------------------
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
+
+Bug Fixes:
+
+Known Bugs:

update.json

@@ -174,6 +174,41 @@
           "file": "SAMMI Updater.exe"
         }
       }
+    },
+    {
+      "version": "2023.3.1",
+      "components": {
+        "SAMMI Core": {
+          "version": "2023.3.1.0",
+          "sum": "dc3653cf510aadce5777810af5ff56e24244b6f13279d36d99db6b432714f995",
+          "path": "",
+          "file": "SAMMI Core.exe"
+        },
+        "SAMMI Voice": {
+          "version": "1.0.1.0",
+          "sum": "c18321fbddb498618455945b6407d0ec736b65a3c6fee444eebdbbfd4c2b68de",
+          "path": "SAMMI Voice",
+          "file": "SAMMI Voice.exe"
+        },
+        "SAMMI Bridge": {
+          "version": "7.22",
+          "path": "bridge",
+          "file": "default.txt",
+          "sum": null
+        },
+        "SAMMI Panel": {
+          "version": "0.9.2",
+          "sum": "8034f244eac5689999d0f9ff7b237d390c36772ef3fe327afb04eab7537a15cf",
+          "path": "SAMMI Panel",
+          "file": "SAMMI Panel.exe"
+        },
+        "SAMMI Updater": {
+          "version": "1.0.1.0",
+          "sum": "0c179074c9a039cb91608c89f274ec52",
+          "path": "SAMMI Updater",
+          "file": "SAMMI Updater.exe"
+        }
+      }
     }
   ]
 }

update.txt

@@ -1 +1 @@
-qEI4X34QW3qdgWoC/6jw+R6/JAJWPVNJABitQ36HJECbwBXjmqsX0+nrD7drsCNhZlgca9kL+GBjTWOjXysayWv0LAi4s595IefML+n/8mz1oPVqHL73U1DLHbWM890G1Q47YAzkpIdwU4tgmHB9Jjqmao/ESLRqMozc4N9l6MrULS0JE87VrGDbgn/KPsJE/HuI3FKUpCMHSHDSO8UpDSH8DLjFZPc6mBEohEFCIBoeU+rZ3bvNRG02hH4ZncW9jAiEauhf0O2EaHJQ0Oui3D2a3W7Bydz7bAEGEDRhZXrwEte23YH6zxT7SS/biqpjRDlfZarn+frzwftRGKdO4bknwB5bejIUT52H8MXAU0OHBuqAa4QgZu3QbtjIbWPvNNBTyQmpQCBH2MICRx3XM7isb+Qn+kNFgPEWterv1pMDoillcyoITnWChvduPeSOzAvRQVbQImYbEK/II0XHPrCgdsL3acHAdyoTbcIkbQdbnORTLGs5l2gRAzlpoySCoMm5cmcSXtC3YL6PcYCAMHs42OiRa5xFjAu2Ac9JFSwhLd1ZBIOF5fhnBOfzdqsqGy4Zsi3DpWeHYF1F7n/sMNSpcPRFQfk185WMTnPttlJeV0O9HZLApsK3Q8WowM2HGnDXhfWNYhe8wBHUb6KkWHjJ+lGZGvJaCsemrRy5gDiO5gkzVAqfn+aYYgLXEmQAezPd51oRhtfQK8J4dQfUZmtPLD/HK3GHRPIbkITtFHuS+qPNEXiOO3dH6ls1pRrJxIIl4GrKzbYmI5yH7JKooeVgJQlueSisDSQ19McBo8tIpSIaLdHjUmSs9y4bsBEYJ/V26owIRsWh9TIMOL+xd4WijmbN6ff5PA+8+zGJLxOh7TkjneTruSVngmTafBzz87rzFd3pFP26ZRiHCZNitEdF+EBgFthKnehum5fqHbGn95GXkrlt+ShZRO/D8Oun
+qEI4X34QW3qdgWoC/6jw+R6/JAJWPVNJABitQ36HJECbwBXjmqsX0+nrD7drsCNhZlgca9kL+GBjTWOjXysayWv0LAi4s595IefML+n/8mz1oPVqHL73U1DLHbWM890G1Q47YAzkpIdwU4tgmHB9Jjqmao/ESLRqMozc4N9l6MrULS0JE87VrGDbgn/KPsJE/HuI3FKUpCMHSHDSO8UpDSH8DLjFZPc6mBEohEFCIBoeU+rZ3bvNRG02hH4ZncW9jA2CYL4MhumHa3gN0Omk3j+f1muUyYqhbAMCQ2FlMi/2GYHniIStlU37SS/biqpjRDlfZarn+frzwftRGKdO4bknwB5bejIUT52H8MXAU0OHBuqAa4QgZu3QbtjIbWPvNNBTyQmpQCBH2MICRx3XM7isb+Qn+kNFgPEWterv1pMDoillLSpSTXGAiqAxObaIylDcQl+CIDZJRv/ILkqSauGjcJajO8WccylBasIkbQdbnORTLGs5l2gRAzlpoySCoMntIT0QUoTrM7CJeIeEZS1q2O/GPMpBiQ++DZtLEnsiJ9laVo/W4PliBOfzdqsqGy4Zsi3DpWeHYF1F7n/sMNSpcPRFQfk185WMTnPttlJeV0O9HZLApsK3Q8WowM2HGnDWhfWNYhe8wBHUb6KkWHjJ+lHKHvVRC8r8rU3g0j6B6F5iVAPJn+POYlbTRGJad2eO5ghCgtTXdJYrdwXWMWoSfmiRLHWGR/dIkYLhEnnJ/PLAEXiOO3dH6ls1pRrJxIIl4GrKzbYmI5yH7JKooeVgJQlueSisDSQ19McBo8tIpSIaLdHjUmSs9y4bsBEYJ/V26owIRsWh9TIMOL+xd4WijmbN6ff5PA+8+zGJLxOh7TkjneTruSVngmTafBzz87rzFd3pFP26ZRiHCZNitEdF+EBgFthKnehum5fqHbGn95GXkrlt+ShZRO/D8Oun

x64/options.ini

@@ -1,6 +1,6 @@
-[Windows]
-SleepMargin=0
-Usex64=True
-[LLVM-WINDOWS]
-VisualStudioDir=C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat
-[sammiDLL]
+[Windows]
+SleepMargin=0
+Usex64=True
+[LLVM-WINDOWS]
+VisualStudioDir=C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\VsDevCmd.bat
+[sammiDLL]

x64/patch notes.txt

@@ -1,41 +1,111 @@
 ====================================
-     SAMMI 2023.3.0 (October 2023)
+     SAMMI 2023.3.1 (December 2023)
 ====================================
 
 [SAMMI Core]
 -------------------------------------
 New Features:
-- Added new Command: "Twitch: Reply to Message" - Reply to Twitch messages directly instead of just sending chat messages [Chrizzz]
-- New Integration: Pulsoid - This integration sends your heartrate to SAMMI as long as you use any pulsoid device (will be available soon) [Chrizzz]
-- Added new "Alert Log" function - You can activate it in the settings menu for SAMMI to document all yellow alerts in a logfile (alert.log) [Chrizzz]
-- Added the deck names to the variable viewer for all persistent buttons to easily find which deck your buttons belong to [Chrizzz & Silverlink]
-- Added a "RefreshBrowserSource" template to the "Send OBS Request" templates for OBSWS5 [Chrizzz]
-- Added "fullFPS" key you can set to "1" in settings.ini, to keep full FPS when SAMMI is not in focus [Christina]
+- Added new Command: "Get Button Color" - Fetches the button color [Chrizzz]
+- Added new Command: "Get Button Text" - Fetches the text of a button  [Chrizzz]
+- Added new DEV mode command: "Get Instance ID" - Fetches the instance ID of the current button execution [Chrizzz]
+- For hotkey button triggers, Trigger Pull Data command now returns the hotkey and its modifiers that triggered the button [Christina]
+- Added Pulsoid Extension Triggers which let you filter the Heartrate directly inside the trigger [Chrizzz]
+- Added instance_id and button_id to extension trigger pull values [Chrizzz]
+- Added 'Edit' button in the Variable Viewer (when inside a button). This enables opening the Edit Commands Window for that specific button [Christina]
+- Local API now accepts `all` as variable name for `getVariable` request, allowing you to grab the whole button object [Christina]
 
+Improvements:
+- Updated the "Send OBS Request" command to add all missing requests as templates. There are now some templates for commands already in SAMMI Core. This gives the ability to recieve more verbose information for already existing OBS commands. [Landie]
+- If the default Bridge port is not available (e.g. SAMMI crashed and Windows assumes the port is still in use), SAMMI will use a backup port instead (no user action required) [Christina]
+- Optimized Panel protocol; connect and disconnect messages now accurately display the Panel Name [Christina]
+- "Twitch Extra Edit Reward" Login name can be left empty and it will default to your Streamer Account [Chrizzz]
+- The following commands have been upgraded to natively handle objects/arrays (eliminating the need for the Stringify Object/Array command): [Christina]
+  - Set Local Variable, Set Button Variable, Set Button instance Variable, Set Global Variable
+  - Set Object Variable
+  - Array Insert, Array Replace
+  - Note: This implementation was intricate; please report any inconsistencies
+  - IMPORTANT: The Bridge and Local API commands are not yet upgraded to support this feature
+- Improved OBS protocol to account for changes introduced in OBS 30.0, such as correctly setting `connected` variable when OBS is ready to accept requests, or retrying requests when OBS is too busy to respond [Christina]
+- Changed how Deck thumbnails are created - they should now be automatically created by simply entering the deck [Christina]
+
+UI Changes:
+
+Removed Features:
+- Removed support for outdated SAMMI Deck and LioranBoard 2 Stream Deck (including the APK) [Christina]
+  - Please proceed to use SAMMI Panel, or one of the other 3rd party alternatives (Deck Hopper, DeckMate)
+- Removed SAMMI Deck Connected/Disconnected trigger [Christina]
+- Removed global variables `deck_connected` and `deck_version` [Christina]
+
+Bug Fixes:
+- Fixed follower alerts not triggering by adding Eventsub [Christina]
+  - Due to SAMMI using Eventsub for Follower Alerts now, you can only have one Twitch account listening to Follower Alerts 
+    - Navigate to SAMMI Core > Twitch Accounts > Check "New Follows" under "Listen For" section only for one account > Disconnect and Connect to Twitch again
+- Button IDs now get properly duplicated when using Duplicate Deck, with correct payload being sent to SAMMI Panel [Christina]
+- Resolved an issue in Mix It Up: Get Commands command, where now all commands are returned (increased limit to 1000) [Christina]
+- Addressed a minor memory leak when saving a button [Christina]
+- Fixed a memory leak during Panel connection [Christina]
+- Fixed a bug with "Twitch Extra Edit Reward" where Cooldowns and Limits weren't updating correctly [Chrizzz]
+- Resolved a critical issue in the "Array: Pull" and "Array: Remove" commands, which previously led to the destruction of internal structures when used on arrays that had already been deleted. This might have also been a factor in deck/button corruption [Christina].
+  - IMPORTANT: Users who have been utilizing arrays by reference (displayed as numbers in variable viewers) will experience a significant change, as such usage was not originally intended.
+- Fixed a bug where an extension file would be deleted from bridge/extensions/installed folder if it was selected to be installed again [Christina]
+
+
+Known Bugs:
+
+[SAMMI Bridge]
+-------------------------------------
+New Features:
 
 Improvements:
-- Rewrote the "Twitch: Get Latest Followers" and "Twitch: Get Follower Count" command to use the new API endpoint to make them work again [Chrizzz]
-- Renamed the "error_log.txt" file to "error.log" [Chrizzz]
-- Whenever SAMMI shuts down or crashes, all active socket connections (e.g. Bridge, Panel, Twitch) are now forcibly closed. This ensures SAMMI doesn't occupy ports unnecessarily, which sometimes needed a complete system reboot. [Christina]
-- When the "Trigger Button" command is used, the "Trigger Pull Data" command inside the button which got triggered can now fetch the Instance ID of the originating button. This allows you to set variables in the originating button even if it's not persistent. [Christina]
+- If connection to SAMMI fails, Bridge attempts to use a backup port instead (e.g. SAMMI was not able to establish a websocket server on the default port, and is using a backup port) [Christina]
+- SAMMI.getVariable now accepts `all` as variable name, allowing you to grab the whole button object [Christina]
 
 UI Changes:
-- Removed beta tags in the settings menu [Chrizzz]
 
 Removed Features:
 
+Bug Fixes:
+
+Known Bugs:
+
+[SAMMI Voice]
+-------------------------------------
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
 
 Bug Fixes:
-- Fixed Local API Set Variable endpoint where setting a variable to a number did not properly work [Christina]
-- Fixed some command error alerts missing information [Christina]
-- Fixed various crashes related to sockets, checkboxes, closing Twitch connection window, Twitch API command errors, installing extensions and more [Christina]
 
+Known Bugs:
 
-[SAMMI Bridge]
+[SAMMI Panel]
 -------------------------------------
-New Features: 
-- Added SAMMI.loadIni() function to load text/number from ini file directly from Bridge [Christina]
-- Added SAMMI.saveIni() function to save text/number to ini file directly from Bridge [Christina]
-- Added SAMMI.httpRequest() to make an API call directly from SAMMI (to avoid browser CORS errors) [Christina]
-- Added SAMMI.openURL() to open a URL in a default browser directly from SAMMI (rather than opening it in OBS if Bridge is docked) [Christina]
-- Added SAMMI.editButton() to quickly navigate to the selected button's edit commands screen window in SAMMI Core directly from Bridge. Highly experimental. [Christina]
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
+
+Bug Fixes:
+
+Known Bugs:
+
+[SAMMI Updater]
+-------------------------------------
+New Features:
+
+Improvements:
+
+UI Changes:
+
+Removed Features:
+
+Bug Fixes:
+
+Known Bugs: