modValue to calcValue changes and readme additions

Author: muppet9010

Profiles/Factorio - Advanced Usage Example.json

@@ -8,12 +8,12 @@
                 {
                     "condition": "[VALUE] >= 10",
                     "manipulator": "int([VALUE]/10)",
-                    "action": "/a_custom_command [MODVALUE] '[BESTNAME]'"
+                    "action": "/a_custom_command [CALCVALUE] '[BESTNAME]'"
                 },
                 {
                     "condition": "[ALL]",
-                    "manipulator": "myValue = floor([VALUE])\nmodValue = myValue * 2",
-                    "action": "special modValue: \"[MODVALUE]\""
+                    "manipulator": "myValue = floor([VALUE])\ncalcValue = myValue * 2",
+                    "action": "special calcValue: \"[CALCVALUE]\""
                 }
             ]
         },
@@ -23,7 +23,7 @@
                 {
                     "condition": "[ALL]",
                     "manipulator": "'bob'",
-                    "action": "static manipulator value: \"[MODVALUE]\""
+                    "action": "static manipulator value: \"[CALCVALUE]\""
                 }
             ]
         },
@@ -33,7 +33,7 @@
                 {
                     "condition": "[VALUE] >= 0",
                     "manipulator": "'bo\\'b'",
-                    "action": "/sc game.print('[MODVALUE]\\'s great' .. ' and ' .. \"[BESTNAME]'s awesome\")"
+                    "action": "/sc game.print('[CALCVALUE]\\'s great' .. ' and ' .. \"[BESTNAME]'s awesome\")"
                 }
             ]
         }

Profiles/Factorio - Print Most Fancy.json

@@ -9,7 +9,7 @@
                 {
                     "condition": "[VALUE] >= 5",
                     "manipulator": "[VALUE] * 1.5",
-                    "action": "Thanks for the $[VALUE] donation [name], its worth $[MODVALUE] to me"
+                    "action": "Thanks for the $[VALUE] donation [name], its worth $[CALCVALUE] to me"
                 },
                 {
                     "condition": "[VALUE] < 5",

README.md

@@ -34,19 +34,25 @@ When an Streamlabs event is received it is processed to have the standard `[ALL]
 
 Assuming a reaction for the event is found the reaction's filter script is checked for the first that is met (resolves to True). Filters allow a scripts conditions to be used to select the approperiate action to do for the event. All of the events data attributes from Streamlabs and this app can be used witihn the filter in the format `[DATA_ITEM_NAME]`. i.e. `[VALUE] >= 5 and [VALUE] < 10`. There is a special `ALL` filter option that it configured will be triggered after all other filters have been checked. The filters within a reaction are not order specific and so should not overlap each others conditions.
 
-The first complying reaction filter will then run an optional manipulator script if configured. This creates a new data item for the event `[MODVALUE]` with the scripts output value. This is used when you want to pass a modified value in to the game.
+The first complying reaction filter will then run an optional manipulator script if configured. This creates a new data item for the event `[CALCVALUE]` with the scripts output value. This is used when you want to pass a modified value in to the game.
 
-The action tied to the filter are the Rcon commands that are run in the game. It can utilise any of the events data attributes in the standard format `[DATA_ITEM_NAME]`. i.e. `[name] supported with $[VALUE] worth $[MODVALUE]` or `/promote [name]`. There is a special `NOTHING` action that is intended for intentionally ignoring the event. This avoids any warnings about unhandled events. Actions can be either a specific Lua command string or the name of a shared Lua command string within the profile. This is to allow re-use of Lua command strings when its convienent. Should an Rcon command get a response from the server it will be shown in the Activity Log as is liekly an error from the game.
+The action tied to the filter are the Rcon commands that are run in the game. It can utilise any of the events data attributes in the standard format `[DATA_ITEM_NAME]`. i.e. `[name] supported with $[VALUE] worth $[CALCVALUE]` or `/promote [name]`. There is a special `NOTHING` action that is intended for intentionally ignoring the event. This avoids any warnings about unhandled events. Actions can be either a specific Lua command string or the name of a shared Lua command string within the profile. This is to allow re-use of Lua command strings when its convienent. Should an Rcon command get a response from the server it will be shown in the Activity Log as is liekly an error from the game.
 
-All data attributes used in scripts are replaced with their event data values at execution time. The replaced text may require wrapping in quotes if it needs to be treated as a string. A script is a single python expression that can be processed via the Python eval() function.
+All data attributes used in scripts are replaced with their event data values at execution time. The replaced text may require wrapping in quotes if it needs to be treated as a string. A script is a single python expression that can be processed via the Python eval() function. It is executed within an environment that includes the Python maths module.
 
 When the application starts up all profiles in the profile folder are checked for their compliance with the event handler types and their attributes. All conditions and manipulators will be tested with a value of "1" for all attributes to confirm they are valid python scripts. Any issues causes the program to stop loading and the issue is recorded to the log file. This is to avoid failure from mis-configuration at run time.
 Additional profiles can be created within the Profiles folder following the sample profile syntax and the eventDefinitions.json events and attributes.
 
 After configuring the application it is advised to run it and use the Streamlabs Test Widget option to send test events and confirm it behaves as you expect.
 
+
+Creating Profiles Notes
+========
+
 Profile configuration files must be created with knowledge of quote escaping. The profile file is in the JSON syntax and so all text strings must be wrapped in double quotes `"` within it. If you want to use a duoble quote within a text string it must be escaped with a back slash `\`. Single quotes can be used fine within a JSON string and are advised for this reason. Data attributes will be made safe by the program; with any single or doube quotes either being removed by Python automatically or escaped with a backslash before being used as part of an rcon command. If you require a single or double quote to be recieved by Rcon escaped then you must escape it with 2 back slashes `\\'`. See the `Factorio - Advanced Usage Example.json` for examples of the some of these combinations.
 
+Manipulator script's are special in that they support raw python code that will be executed within a Python exec() function in addition to a python expression that is executed within a Python eval() function. The event handler will try to eval() the manipulator script first and should it error then try to exec() the manipulator script. As the manipulator script is supplied via the profile JSON file it must be in a single line format with `\n` for the line breaks. The Python maths module is included within the execution environment. The local variable `calcValue` is passed out of the exec environment as the value of `CALCVALUE`. See the `Factorio - Advanced Usage Example.json` for examples of the some of these combinations.
+
 
 Development Building
 =============

Source/StreamlabsEvent.py

@@ -171,13 +171,13 @@ def GetEventRawTitlesAsPrettyString(self):
             eventDesc = "No Title Details"
         return eventDesc
 
-    def SubstituteEventDataIntoString(self, string, modValue="''"):
+    def SubstituteEventDataIntoString(self, string, calcValue="''"):
         instances = StreamlabsEventUtils.FindAttributeTagsInString(string)
         for instance in instances:
             dataKeyName = instance[1:-1]
             dataKeyValue = "''"
-            if dataKeyName == "MODVALUE":
-                dataKeyValue = modValue
+            if dataKeyName == "CALCVALUE":
+                dataKeyValue = calcValue
             elif dataKeyName == "VALUE":
                 dataKeyValue = self.GetValueForDisplay()
             elif dataKeyName == "PLATFORM":
@@ -225,14 +225,14 @@ def LoadEventDefinitions():
         StreamlabsEventUtils.handledEventTypes = data
 
     @staticmethod
-    def IsBadEventAttritubeUsed(eventType, string, modValueAllowed):
+    def IsBadEventAttritubeUsed(eventType, string, calcValueAllowed):
         if string in ["", "[ALL]", "[NOTHING]"]:
             return ""
         instances = StreamlabsEventUtils.FindAttributeTagsInString(string)
         for instance in instances:
             dataKeyName = instance[1:-1]
-            if dataKeyName == "MODVALUE" and not modValueAllowed:
-                return "[MODVALUE] used when not allowed"
+            if dataKeyName == "CALCVALUE" and not calcValueAllowed:
+                return "[CALCVALUE] used when not allowed"
             if dataKeyName in StreamlabsEventUtils.handledEventTypes['[ALL]'].keys():
                 continue
             if eventType == "" or dataKeyName not in StreamlabsEventUtils.handledEventTypes[eventType].keys():
@@ -259,8 +259,8 @@ def IsScriptValid(scriptString):
 
     @staticmethod
     def ProcessExecScript(scriptString):
-        locals = {"modValue": 0}
+        locals = {"calcValue": 0}
         globals = {}
         script = "from math import *\n" + scriptString + "\n"
         exec(script, globals, locals)
-        return locals["modValue"]
+        return locals["calcValue"]

Source/eventDefinitions.json

@@ -20,7 +20,7 @@
             "valueType": "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": {
+        "CALCVALUE": {
             "valueType": "number",
             "description": "Action only - an optional calculated value generated by the manipulator script that is only available in the action script."
         },

ToDo.txt

@@ -4,19 +4,16 @@ Make so that profile startup errors are shown in a GUI and disable running until
 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.
+Support multiple calculated values via exec. Array in exec, to numbered strings in action script.
+Support multiple rcon commands as an array in JSON.
 
 
 
 
-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.
+add option for getting gift subscriptions from the gifter view as well as from the receiver view
 
-Support multiple rcon commands as an array in JSON.
+can have multiple payloads per event. need to split these up to separate events internally.
 
-Support multiple calculated values via exec. Array in exec, to numbered strings in action script.
 
-change modvalue to calcvalue

my custom profiles/ColonelWill - Chat Hunts Will.json

@@ -7,8 +7,8 @@
             "filteredActions": [
                 {
                     "condition": "[VALUE] >= 1",
-                    "manipulator": "value = floor([VALUE])\nvalue100 = int(value/100)\nmodValue = modValue + (value100 * 1500)\nvalue = value - (value100 * 100)\nvalue50 = int(value/50)\nmodValue = modValue + (value50 * 500)\nvalue = value - (value50 * 50)\nvalue25 = int(value/25)\nmodValue = modValue + (value25 * 175)\nvalue = value - (value25 * 25)\nvalue10 = int(value/10)\nmodValue = modValue + (value10 * 60)\nvalue = value - (value10 * 10)\nvalue5 = int(value/5)\nmodValue = modValue + (value5 * 25)\nvalue = value - (value5 * 5)\nmodValue = modValue + (value * 3)",
-                    "action": "/add-biters [MODVALUE] '[BESTNAME]'"
+                    "manipulator": "value = floor([VALUE])\nvalue100 = int(value/100)\ncalcValue = calcValue + (value100 * 1500)\nvalue = value - (value100 * 100)\nvalue50 = int(value/50)\ncalcValue = calcValue + (value50 * 500)\nvalue = value - (value50 * 50)\nvalue25 = int(value/25)\ncalcValue = calcValue + (value25 * 175)\nvalue = value - (value25 * 25)\nvalue10 = int(value/10)\ncalcValue = calcValue + (value10 * 60)\nvalue = value - (value10 * 10)\nvalue5 = int(value/5)\ncalcValue = calcValue + (value5 * 25)\nvalue = value - (value5 * 5)\ncalcValue = calcValue + (value * 3)",
+                    "action": "/add-biters [CALCVALUE] '[BESTNAME]'"
                 },
                 {
                     "condition": "[ALL]",
@@ -32,8 +32,8 @@
             "filteredActions": [
                 {
                     "condition": "[VALUE] >= 5",
-                    "manipulator": "value = floor([VALUE])\nvalue100 = int(value/100)\nmodValue = modValue + (value100 * 1500)\nvalue = value - (value100 * 100)\nvalue50 = int(value/50)\nmodValue = modValue + (value50 * 500)\nvalue = value - (value50 * 50)\nvalue25 = int(value/25)\nmodValue = modValue + (value25 * 175)\nvalue = value - (value25 * 25)\nvalue10 = int(value/10)\nmodValue = modValue + (value10 * 60)\nvalue = value - (value10 * 10)\nvalue5 = int(value/5)\nmodValue = modValue + (value5 * 25)\nvalue = value - (value5 * 5)\nmodValue = modValue + (value * 3)",
-                    "action": "/add-biters [MODVALUE] '[BESTNAME]'"
+                    "manipulator": "value = floor([VALUE])\nvalue100 = int(value/100)\ncalcValue = calcValue + (value100 * 1500)\nvalue = value - (value100 * 100)\nvalue50 = int(value/50)\ncalcValue = calcValue + (value50 * 500)\nvalue = value - (value50 * 50)\nvalue25 = int(value/25)\ncalcValue = calcValue + (value25 * 175)\nvalue = value - (value25 * 25)\nvalue10 = int(value/10)\ncalcValue = calcValue + (value10 * 60)\nvalue = value - (value10 * 10)\nvalue5 = int(value/5)\ncalcValue = calcValue + (value5 * 25)\nvalue = value - (value5 * 5)\ncalcValue = calcValue + (value * 3)",
+                    "action": "/add-biters [CALCVALUE] '[BESTNAME]'"
                 },
                 {
                     "condition": "[ALL]",