add patreon pledge event type

Author: muppet9010

README.md

@@ -1,7 +1,7 @@
 # Streamlabs-Rcon-Integration
 
 
-A Python exe for integrating Streamlabs and any game supporting Rcon. Its currently being used with Factorio, but should be compatible with any other Rcon interfaced game. 
+A Python exe for integrating Streamlabs and any game supporting Rcon. 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.
 
@@ -18,6 +18,8 @@ Installation & Usage
 
 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.
 
+Note: on clicking `Start` the program checks the RCON connection. If a Factorio server has been paused by a player then the RCON command will never respond and the application will freeze. Make sure that Factorio hasn't been paused by a player when clicking to `Start`. A server with 0 players on is not in this state.
+
 
 Program Execution Concepts
 ========

Source/StreamlabsEvent.py

@@ -116,6 +116,10 @@ def PopulateNormalisedData(self):
             self.value = self.state.currency.GetNormalisedValue(
                 self.rawMessage["currency"], float(self.rawMessage["amount"]))
             self.state.donationsIdsProcessed[self.id] = True
+        elif (self.handlerName == "patreon-pledge"):
+            self.valueType = "money"
+            self.value = self.state.currency.GetNormalisedValue(
+                self.rawMessage["currency"], float(self.rawMessage["amount"]))
         elif (self.handlerName == "youtube_account-superchat"):
             self.valueType = "money"
             self.value = self.state.currency.GetNormalisedValue(

Source/eventDefinitions.json

@@ -18,7 +18,7 @@
         },
         "VALUE": {
             "valueType": "number",
-            "description": "the standardised value of the event. Donations and money amounts are converted to USD. Subscriptions have the USD cost of them. Follows and Hosts have the viewer count. This may be a decimal number"
+            "description": "the standardised value of the event. Donations and money amounts are converted to USD with 2 decimal digits for cents if needed. Subscriptions have the USD cost of them. Follows and Hosts have the viewer count."
         },
         "MODVALUE": {
             "valueType": "number",
@@ -55,6 +55,24 @@
             "description": "the 3 letter currance code, i.e. USD, GBP"
         }
     },
+    "patreon-pledge": {
+        "name": {
+            "valueType": "text string",
+            "description": "the username of the person who did the event"
+        },
+        "formatted_amount": {
+            "valueType": "text string",
+            "description": "the amount as 2 decimal places and the currancy symbol"
+        },
+        "amount": {
+            "valueType": "number",
+            "description": "the amount of the donation with a variable (0-10) number of decimal places"
+        },
+        "currency": {
+            "valueType": "text string",
+            "description": "the 3 letter currance code, i.e. USD, GBP"
+        }
+    },
     "twitch_account-subscription": {
         "name": {
             "valueType": "text string",

ToDo.txt

@@ -3,4 +3,20 @@ Make a profile manager GUI
 Make so that profile startup errors are shown in a GUI and disable running until fixed.
 Have seperate Activity and System (status, warning, errors) logs
 Have a way to pause logs from updating and then resume
-Add a way to fire test events data at this to allow better testing of responses than the Streamlabs Test Widgets button.
+Add a way to fire test events data at this to allow better testing of responses than the Streamlabs Test Widgets button.
+
+
+
+
+the integration handles gifted subs for the recipient of the sub, but knowing its been gifted by someone.
+that's probably something to add to the integration list to be able to handle gifted subs as single donation from the gifter.
+
+add option for getting gift subscriptions from the gifter view and not from the receiver view
+
+can have multiple payloads per event. need to split these up to separate events internally.
+
+Support multiple rcon commands as an array in JSON.
+
+Support multiple calculated values via exec. Array in exec, to numbered strings in action script.
+
+change modvalue to calcvalue

event samples.txt

@@ -28,4 +28,7 @@ TWITCH REAL WORLD
 
 22:43:07 : Streamlabs supported raw event received: {'type': 'raid', 'message': [{'id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275', 'name': 'user', 'display_name': 'UsEr', 'raiders': '28', '_id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275', 'event_id': 'a7ca29ca-03c8-4857-b9d4-915fa03fc275'}], 'for': 'twitch_account'}
 
-19:37:29 : Streamlabs raw event data: {'type': 'pledge', 'message': [{'name': 'UsEr', 'isTest': True, 'formatted_amount': '£56.00', 'amount': 56, 'currency': 'GBP', 'to': {'name': 'StReAmErNaMe'}, 'from': 'Real Name', '_id': '938e6fdb71d5b11a19d170c3dbca555c'}], 'for': 'patreon', 'event_id': 'evt_a5f4b15b617c16d498f8fdf6d0865aaa'}
+19:37:29 : Streamlabs raw event data: {'type': 'pledge', 'message': [{'name': 'UsEr', 'isTest': True, 'formatted_amount': '£56.00', 'amount': 56, 'currency': 'GBP', 'to': {'name': 'StReAmErNaMe'}, 'from': 'Real Name', '_id': '938e6fdb71d5b11a19d170c3dbca555c'}], 'for': 'patreon', 'event_id': 'evt_a5f4b15b617c16d498f8fdf6d0865aaa'}
+
+multiple payload entries per event (any of them potentially):
+00:00:14 : Streamlabs event errored during initial handling: {id: '', platform: 'twitch_account', type: 'follow', errored: 'True', ignored: 'False', handlerName: '', valueType: '', value: '0.0', bestName: '', rawData: {'type': 'follow', 'message': [{'created_at': '2019-06-12 23:00:00', 'id': '12345678', 'name': 'UsEr1', '_id': '34ba6c0ce4412ccacf965ae4042076fa', 'event_id': '34ba6c0ce4412ccacf965ae4042076fa'}, {'created_at': '2019-06-12 22:59:56', 'id': '56789056789', 'name': 'UsEr2', '_id': '1f1ebd9a598f64fad10875baefb89f5b', 'event_id': '1f1ebd9a598f64fad10875baefb89f5b'}], 'for': 'twitch_account'}}