Fully support Twitch Sub Mystery Gift

Expand testing options to handle subMysertyGift

Author: muppet9010

Profiles/Factorio - Advanced Usage Example.json

@@ -2,6 +2,39 @@
     "name": "Factorio - Advanced Usage Example",
     "description": "Example of some more complicated uses",
     "reactions": [
+        {
+            "platform": "twitch_account",
+            "type": "subscription",
+            "filteredActions": [
+                {
+                    "condition": "[ALL]",
+                    "manipulator": "",
+                    "action": "[BESTNAME] subscribed themselves"
+                }
+            ]
+        },
+        {
+            "platform": "twitch_account",
+            "type": "subscriptionGift",
+            "filteredActions": [
+                {
+                    "condition": "[ALL]",
+                    "manipulator": "",
+                    "action": "[BESTNAME] was subscribed by [gifter_display_name]"
+                }
+            ]
+        },
+        {
+            "platform": "twitch_account",
+            "type": "subMysteryGift",
+            "filteredActions": [
+                {
+                    "condition": "[ALL]",
+                    "manipulator": "",
+                    "action": "subMysterGift donator enabled: [BESTNAME] subscribed [amount] users"
+                }
+            ]
+        },
         {
             "valueType": "money",
             "filteredActions": [
@@ -37,5 +70,8 @@
                 }
             ]
         }
-    ]
+    ],
+    "options": {
+        "twitchMysterSubGiftMode": "donator"
+    }
 }

Profiles/Factorio - Print All.json

@@ -32,5 +32,8 @@
                 }
             ]
         }
-    ]
+    ],
+    "options": {
+        "twitchMysterSubGiftMode": "donator"
+    }
 }

Profiles/Factorio - Print Most Fancy.json

@@ -92,5 +92,8 @@
             "description": "Say thanks for small value stuff",
             "effect": "Ta for $[VALUE] [BESTNAME]"
         }
-    ]
+    ],
+    "options": {
+        "twitchMysterSubGiftMode": "donator"
+    }
 }

README.md

@@ -3,18 +3,19 @@
 
 A Python exe for integrating Streamlabs and any game supporting Rcon. It receives the Streamlabs events and uses configurable logic to send an approperiate RCON command to the game server to do something. Its currently being used with Factorio, but should be compatible with any other Rcon interfaced game.
 
-At present only really tested with Twitch, but should work with mixer and youtube based on API spec.
+At present only really tested with Twitch, but should work with mixer and youtube based on API spec. The tool runs fully on your pc removing any risk of sharing access keys or donators details.
 
 
 Installation & Usage
 ==========
-1. Get the [latest version zip](https://github.com/muppet9010/Streamlabs-Rcon-Integration).
-2. Create a free account at [Currency Layer website](https://currencylayer.com) and make a note of the API access key as needs to be entered in to the programs config later on.
-3. Unzip the files in to the desired folder.
-4. Open config.json in a text editor and add in your details.
-5. Run the program: Streamlabs Rcon Integration.exe
-6. Select the desired profile from the dropdown and click Start.
-7. The integration is now running between the Streamlabs account and the game using the selected profile.
+1. Install the current release of Python 3.7 with default options: https://www.python.org/downloads
+2. Get the [latest version zip](https://github.com/muppet9010/Streamlabs-Rcon-Integration).
+3. Create a free account at [Currency Layer website](https://currencylayer.com) and make a note of the API access key as needs to be entered in to the programs config later on.
+4. Unzip the files in to the desired folder.
+5. Open config.json in a text editor and add in your details.
+6. Run the program: Streamlabs Rcon Integration.exe
+7. Select the desired profile from the dropdown and click Start.
+8. The integration is now running between the Streamlabs account and the game using the selected profile.
 
 Should a critical error occur the program may fail to load or close. Details can be found in the most recent log file within the Logs folder.
 
@@ -55,6 +56,11 @@ Manipulator script's are special in that they support raw python code that will
 
 The config has a `Rcon No Commands` option. When enabled it prints the RCON commands to the activity window rather than sending them. It also skips the RCON connection test which the Start button is clicked within the app. In effect not doing any RCON commands.
 
+Profiles can have `options` specified for them to control specific program behavior:
+- twitchMysterSubGiftMode = when Twitch Subscription Mystery Gifts are given out by a viewer to random other viewers the event can either be reacted to for the donator or receiver. The programs default is the `donator` value if the setting isn't specified in the profile's options. The `money` valyeType will obey this setting and the other event type won't be triggered for Twitch Subscription Mystery Gifts to avoid duplicate reactions.
+    - `donator` - react to it as one large donation using the `subMysteryGift` event reaction.
+    - `receiver` - react to each viewer getting the gifted subscription using the `subscriptionGift` event reaction.
+
 
 Development Building
 =============

Source/Gui.py

@@ -74,7 +74,7 @@ def _CreateBottomBar(self, parent):
         self.selectedTestEventPlatform = TK.StringVar()
         self.selectedTestEventPlatform.trace_variable(
             TK.W, self.OnTestEventPlatformChanged)
-        orderedTestEventPlatforms = self.state.testEvents.GetPlatforms()
+        orderedTestEventPlatforms = self.state.testEventUtils.GetPlatforms()
         self.testEventPlatformList = TK.OptionMenu(
             bottomBarContainer, self.selectedTestEventPlatform, *orderedTestEventPlatforms)
         self.testEventPlatformList.pack(side=TK.LEFT)
@@ -156,7 +156,7 @@ def OnTestEventPlatformChanged(self, *args):
         self.testEventTypeList["menu"].delete(0, TK.END)
         orderedTestEventTypes = []
         if self.selectedTestEventPlatform.get() != self.translations.GetTranslation("Gui SelectTestEventPlatform"):
-            orderedTestEventTypes = self.state.testEvents.GetPlatformTypes(
+            orderedTestEventTypes = self.state.testEventUtils.GetPlatformTypes(
                 self.selectedTestEventPlatform.get())
         for testEventType in orderedTestEventTypes:
             self.testEventTypeList["menu"].add_command(
@@ -176,9 +176,9 @@ def OnTestEventTypeChanged(self, *args):
         amountEnabled = False
         quantityEnabled = False
         if self.selectedTestEventType.get() != self.translations.GetTranslation("Gui SelectTestEventType"):
-            amountEnabled = self.state.testEvents.GetAttribute(self.selectedTestEventPlatform.get(
+            amountEnabled = self.state.testEventUtils.GetAttribute(self.selectedTestEventPlatform.get(
             ), self.selectedTestEventType.get(), "valueInput")
-            quantityEnabled = self.state.testEvents.GetAttribute(self.selectedTestEventPlatform.get(
+            quantityEnabled = self.state.testEventUtils.GetAttribute(self.selectedTestEventPlatform.get(
             ), self.selectedTestEventType.get(), "quantityInput")
         if amountEnabled:
             self.testEventValueLabel.config(state=TK.NORMAL)

Source/Profiles.py

@@ -38,6 +38,10 @@ def __init__(self, profileData, profiles):
                 self.reactionPriorities[1].append(reaction)
             elif "valueType" in reactionData:
                 self.reactionPriorities[2].append(reaction)
+        if "options" in profileData:
+            self.options = Options(self, profileData["options"])
+        else:
+            self.options = Options(self, {})
 
     def GetActionTextForEvent(self, event):
         for reaction in self.reactionPriorities[1]:
@@ -191,3 +195,15 @@ def __init__(self, actionData):
         self.name = actionData["name"]
         self.description = actionData["description"]
         self.effect = actionData["effect"]
+
+
+class Options:
+    def __init__(self, profile, optionData):
+        self.profile = profile
+        self.logging = self.profile.profiles.state.logging
+        self.twitchMysterSubGiftMode = "donator"
+        if "twitchMysterSubGiftMode" in optionData:
+            self.twitchMysterSubGiftMode = optionData["twitchMysterSubGiftMode"]
+        if self.twitchMysterSubGiftMode not in ("donator", "receiver"):
+            self.logging.LogQuit(self.profile.name +
+                                 " : has invalid twitchMysterSubGiftMode option value: " + self.twitchMysterSubGiftMode)

Source/Streamlabs Rcon Integration.py

@@ -8,7 +8,7 @@
 from Profiles import Profiles
 from Rcon import Rcon
 from Translations import Translations
-from TestEvents import TestEvents
+from TestEvents import TestEventUtils
 
 
 class State():
@@ -20,13 +20,14 @@ def __init__(self):
 
     def Setup(self):
         self.donationsIdsProcessed = {}
+        self.mysterySubGifts = {}
         self.translations = Translations(self)
         self.currency = Currency(self)
         StreamlabsEventUtils.LoadEventDefinitions()
         self.profiles = Profiles(self)
         self.streamlabs = Streamlabs(self)
         self.rcon = Rcon(self)
-        self.testEvents = TestEvents()
+        self.testEventUtils = TestEventUtils()
         self.guiWindow = GuiWindow(self)
         self.gui = self.guiWindow.gui
         self.gui.Setup()
@@ -171,18 +172,22 @@ def OnTestEventButtonHandler(self):
         try:
             testEventPlatform = self.gui.selectedTestEventPlatform.get()
             testEventType = self.gui.selectedTestEventType.get()
-            testEventValue = self.gui.testEventValue.get()
-            if TestEvents.GetAttribute(testEventPlatform, testEventType, "valueInput"):
+            testEventValue = ""
+            if TestEventUtils.GetAttribute(testEventPlatform, testEventType, "valueInput"):
                 try:
+                    testEventValue = self.gui.testEventValue.get()
                     testEventValue = float(testEventValue)
                 except:
                     self.RecordActivity(
                         self.translations.GetTranslation("TestEvent ValueNotFloat") + str(testEventValue))
                     return
-            testEventQuantity = self.gui.testEventQuantity.get()
-            if TestEvents.GetAttribute(testEventPlatform, testEventType, "quantityInput"):
+            testEventQuantity = ""
+            if TestEventUtils.GetAttribute(testEventPlatform, testEventType, "quantityInput"):
                 try:
+                    testEventQuantity = self.gui.testEventQuantity.get()
                     testEventQuantity = int(testEventQuantity)
+                    if testEventQuantity <= 0:
+                        raise ValueError()
                 except:
                     self.RecordActivity(
                         self.translations.GetTranslation("TestEvent QuantityCountNotInt") + str(testEventQuantity))
@@ -196,10 +201,11 @@ def OnTestEventButtonHandler(self):
                 self.RecordActivity(
                     self.translations.GetTranslation("TestEvent PayloadCountNotInt") + str(testEventPayloadCount))
                 return
-            testEvent = self.testEvents.GenerateTestEvent(
+            testEventArray = self.testEventUtils.GenerateTestEventArray(
                 testEventPlatform, testEventType, testEventValue, testEventQuantity, testEventPayloadCount)
-            if testEvent != None:
-                self.OnStreamlabsEventHandler(testEvent)
+            if len(testEventArray) > 0:
+                for testEvent in testEventArray:
+                    self.OnStreamlabsEventHandler(testEvent)
             else:
                 self.RecordActivity(
                     self.translations.GetTranslation("TestEvent InvalidTestEvent") + testEventPlatform + " - " + testEventType)

Source/StreamlabsEvent.py

@@ -19,13 +19,17 @@ def __init__(self, state, platformString, typeString, payload):
         self.rawMessage = {}
         self.errored = False
         self.ignored = False
+        self.rawMessage = payload
+
+        if self.type == "donation" and self.platform == "":
+            self.platform = "streamlabs"
+        elif self.platform == "twitch_account" and self.type == "subscription" and "gifter" in self.rawMessage and self.rawMessage["gifter"] != None:
+            self.type = "subscriptionGift"
 
         if self.ShouldIgnoreEvent():
             self.ignored = True
             return
 
-        self.rawMessage = payload
-
         self.id = self.rawMessage["_id"]
         if "display_name" in self.rawMessage.keys():
             self.bestName = self.rawMessage["display_name"]
@@ -36,10 +40,6 @@ def __init__(self, state, platformString, typeString, payload):
         elif "comment" in self.rawMessage.keys():
             self.bestComment = self.rawMessage["comment"]
 
-        if self.type == "donation" and self.platform == "":
-            self.platform = "streamlabs"
-        elif self.platform == "twitch_account" and self.type == "subscription" and "gifter" in self.rawMessage and self.rawMessage["gifter"] != None:
-            self.type = "subscriptionGift"
         self.handlerName = StreamlabsEventUtils.MakeHandlerString(
             self.platform, self.type)
 
@@ -83,6 +83,14 @@ def ShouldIgnoreEvent(self):
             return True
         if (self.platform == "widget"):
             return True
+        if self.platform == "twitch_account":
+            if self.state.profiles.currentProfile.options.twitchMysterSubGiftMode == "receiver" and self.type == "subMysteryGift":
+                return True
+            elif self.state.profiles.currentProfile.options.twitchMysterSubGiftMode == "donator" and self.type == "subscriptionGift":
+                gifterName = self.rawMessage["gifter_display_name"]
+                if gifterName in self.state.mysterySubGifts and self.state.mysterySubGifts[gifterName] > 0:
+                    self.state.mysterySubGifts[gifterName]-=1
+                    return True
         if self.id in self.state.donationsIdsProcessed:
             self.logging.DebugLog(
                 "Streamlabs donation event being ignored as in processed list: " + self.id)
@@ -121,12 +129,14 @@ def PopulateNormalisedData(self):
             self.valueType = "money"
             subPlan = self.rawMessage["sub_plan"]
             subValue = StreamlabsEventUtils.GetTwitchSubscriptionValue(subPlan)
+            amount = self.rawMessage["amount"]
             if subValue != None:
-                self.value = subValue * self.rawMessage["amount"]
+                self.value = subValue * amount
             else:
                 self.state.RecordActivity(
                     self.state.translations.GetTranslation("StreamlabsEvent UnrecognisedTwitchSubscriptionType") + subPlan)
                 return False
+            self.state.mysterySubGifts[self.bestName] = amount
         elif (self.handlerName == "youtube_account-subscription"):
             self.valueType = "money"
             self.value = 5