Add Test Mode to skip RCON commands and testing

hide "_" the Config class's internal attributes to avoid accidental use

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. 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.
 
@@ -53,6 +53,8 @@ Profile configuration files must be created with knowledge of quote escaping. Th
 
 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.
 
+The config has a `Test Mode` 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.
+
 
 Development Building
 =============

Source/Config.py

@@ -5,14 +5,14 @@
 class Config():
     def __init__(self, state):
         self.state = state
-        self.fileName = "config.json"
-        self.settings = {}
-        if Os.path.isfile(self.fileName):
-            with open(self.fileName, "r") as file:
+        self._fileName = "config.json"
+        self._settings = {}
+        if Os.path.isfile(self._fileName):
+            with open(self._fileName, "r") as file:
                 data = Json.load(file)
             file.closed
-            self.settings = data
-        self.settingsMissing = []
+            self._settings = data
+        self._settingsMissing = []
         self._PopulateMissingConfigDefaults()
 
     def _PopulateMissingConfigDefaults(self):
@@ -26,17 +26,18 @@ def _PopulateMissingConfigDefaults(self):
             "Rcon Server Address": "",
             "Rcon Server Port": 25575,
             "Rcon Server Password": "",
-            "Rcon Test Command": "/version"
+            "Rcon Test Command": "/version",
+            "Test Mode": False
         }
         for name, value in defaults.items():
-            if not name in self.settings:
-                self.settings[name] = value
-                self.settingsMissing.append(name)
+            if not name in self._settings:
+                self._settings[name] = value
+                self._settingsMissing.append(name)
 
     def LogMissingSettings(self):
-        for name in self.settingsMissing:
+        for name in self._settingsMissing:
             self.state.logging.Log(
                 "Config key missing, using default: " + name)
 
     def GetSetting(self, name):
-        return self.settings[name]
+        return self._settings[name]

Source/Rcon.py

@@ -12,6 +12,8 @@ def __init__(self, state):
         self.testCommand = self.state.config.GetSetting("Rcon Test Command")
 
     def TestConnection(self):
+        if self.state.config.GetSetting("Test Mode"):
+            return True
         try:
             self.SendCommand(self.testCommand)
             return True
@@ -22,5 +24,9 @@ def TestConnection(self):
             return False
 
     def SendCommand(self, commandString):
+        if self.state.config.GetSetting("Test Mode"):
+            self.state.RecordActivity(
+                self.state.translations.GetTranslation("Rcon TestMode") + commandString)
+            return ""
         with MCRcon(self.serverAddress, self.serverPassword, self.serverPort) as mcr:
             return mcr.command(commandString)

Source/Translations.py

@@ -29,7 +29,8 @@ def LoadLocalisedTexts(self, language):
                 "StreamlabsEvent EventHandled": "Event Handled: ",
                 "Rcon CommandError": "ERROR: Rcon command failed, run manually: ",
                 "Rcon CommandResponseWarning": "WARNING: Rcon got response from server: ",
-                "Rcon TestErrorMessage": "Rcon connection test message: "
+                "Rcon TestErrorMessage": "Rcon connection test message: ",
+                "Rcon TestMode": "Rcon Test Mode: "
             }
 
     def GetTranslation(self, key):

Source/config.sample.json

@@ -8,5 +8,6 @@
     "Rcon Server Address": "",
     "Rcon Server Port": 25575,
     "Rcon Server Password": "",
-    "Rcon Test Command": "/version"
+    "Rcon Test Command": "/version",
+    "Test Mode": false
 }

ToDo.txt

@@ -6,6 +6,7 @@ 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.
+Handle paused Factorio server accepting but not reply to RCON command. It will honor the command when the server is unpaused. So different between start test connection and event handling.
 
 
 
@@ -15,5 +16,3 @@ Support multiple rcon commands as an array in JSON.
 add option for getting gift subscriptions from the gifter view as well as from the receiver view
 
 can have multiple payloads per event. need to split these up to separate events internally.
-
-