add version and tweak error messages

Author: muppet9010

README.md

@@ -11,11 +11,11 @@ Get the [latest version zip](https://github.com/muppet9010/Streamlabs-Rcon-Integ
 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.
 Unzip the files in to the desired folder.
 Open config.json in a text editor and add in your details.
-Run the: > Streamlabs Rcon Integration.exe
+Run the program: Streamlabs Rcon Integration.exe
 Select the desired profile from the dropdown and click Start.
 The integration is now running between the Streamlabs account and the game using the selected profile.
 
-Should a critical error occur the progra may fail to load or close. Details can be found in the current log within the Logs folder.
+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.
 
 
 Usage Concepts
@@ -54,4 +54,4 @@ Uses the python modules and their dependcies:
 - PyInstaller  =  https://www.pyinstaller.org/
 - MCRcon  =  https://github.com/uncaught-exceptions/mcrcon
 
-Build the scripts into an exe using PyInstaller via Build.bat. It will place the exe in the "build\dist" folder.
+Build the scripts into an exe using PyInstaller via Build.bat. It will place the exe and other files in the `build\dist` folder. This `dist` folder is the program and can be shared via zip.

Source/Gui.py

@@ -4,6 +4,7 @@
 class GuiWindow():
     def __init__(self, state):
         root = TK.Tk()
+        root.title("Streamlabs Rcon Integration - " + state.version)
         root.minsize(500, 200)
         root.geometry("1000x400")
         root.protocol("WM_DELETE_WINDOW", state.OnQuitButtonHandler)
@@ -14,64 +15,64 @@ def __init__(self, state):
 class Gui(TK.Frame):
     def __init__(self, state, master=None):
         super().__init__(master)
-        self.master=master
+        self.master = master
         self.pack()
-        self.state=state
-        self.translations=state.translations
+        self.state = state
+        self.translations = state.translations
 
     def CreateWidgets(self):
         self._CreateRunningBar(self.master)
         self._CreateActivityLog(self.master)
         # self._CreateBottomBar(self.master) # Don't bother with for just a quit button
 
     def _CreateRunningBar(self, parent):
-        runningContainer=TK.Frame(parent)
+        runningContainer = TK.Frame(parent)
         runningContainer.pack(fill=TK.X, side=TK.TOP)
 
-        self.statusText=TK.StringVar()
+        self.statusText = TK.StringVar()
         self.state.UpdateStatus()
-        statusLabel=TK.Label(
+        statusLabel = TK.Label(
             runningContainer, textvariable=self.statusText, height=1, width=30)
         statusLabel.pack(side=TK.LEFT)
 
-        self.selectedProfileName=TK.StringVar()
-        self.sortedProfileNames=sorted(list(
+        self.selectedProfileName = TK.StringVar()
+        self.sortedProfileNames = sorted(list(
             self.state.profiles.profiles.keys()))
-        configProfileDefault=self.state.config.GetSetting("Profile Default")
+        configProfileDefault = self.state.config.GetSetting("Profile Default")
         if configProfileDefault != "" and configProfileDefault in self.sortedProfileNames:
             self.selectedProfileName.set(configProfileDefault)
         else:
             self.selectedProfileName.set(
                 self.translations.currentTexts["Gui SelectProfile"])
-        self.profileList=TK.OptionMenu(
+        self.profileList = TK.OptionMenu(
             runningContainer, self.selectedProfileName, *self.sortedProfileNames)
         self.profileList.pack(side=TK.LEFT)
 
-        self.startButton=TK.Button(runningContainer,
+        self.startButton = TK.Button(runningContainer,
                                      text=self.translations.currentTexts["Gui StartButton"], command=self.state.OnStartButtonHandler)
         self.startButton.pack(side=TK.LEFT)
 
-        self.stopButton=TK.Button(
+        self.stopButton = TK.Button(
             runningContainer, text=self.translations.currentTexts["Gui StopButton"], command=self.state.OnStopButtonHandler)
         self.stopButton.pack(side=TK.LEFT)
 
         self.OnStopped()
 
     def _CreateActivityLog(self, parent):
-        titleFrame=TK.LabelFrame(
+        titleFrame = TK.LabelFrame(
             parent, text=self.translations.currentTexts["Gui ActivityLogTitle"])
         titleFrame.pack(fill=TK.BOTH, expand=True, side=TK.TOP, padx=3, pady=3)
-        yScroll=TK.Scrollbar(titleFrame, orient=TK.VERTICAL)
+        yScroll = TK.Scrollbar(titleFrame, orient=TK.VERTICAL)
         yScroll.pack(fill=TK.Y, expand=False, side=TK.RIGHT)
-        self.activityLogText=TK.Text(
+        self.activityLogText = TK.Text(
             titleFrame, height=5, wrap=TK.WORD, yscrollcommand=yScroll.set, state=TK.DISABLED)
         self.activityLogText.pack(fill=TK.BOTH, expand=True, side=TK.LEFT)
 
     def _CreateBottomBar(self, parent):
-        self.bottomBarContainer=TK.Frame(parent)
+        self.bottomBarContainer = TK.Frame(parent)
         self.bottomBarContainer.pack(fill=TK.X, side=TK.TOP)
 
-        quitButton=TK.Button(self.bottomBarContainer, text=self.translations.currentTexts["Gui QuitButton"], fg="red",
+        quitButton = TK.Button(self.bottomBarContainer, text=self.translations.currentTexts["Gui QuitButton"], fg="red",
                                command=self.state.OnQuitButtonHandler)
         quitButton.pack(side=TK.LEFT)
 

Source/Logging.py

@@ -19,6 +19,7 @@ def __init__(self, state):
         self.logFilePath = logFolder + "/" + logFileName
         self.debugLogFilePath = logFolder + "/Debug" + logFileName
         self.debugLogging = state.config.GetSetting("Logging DebugLogging")
+        self.Log("Logging Started - " + self.state.version)
 
     def _TidyUpOldLogFiles(self, logFolder, currentDT, daysLogsToKeep, dateFormat):
         for name in Os.listdir(logFolder):

Source/Rcon.py

@@ -17,7 +17,8 @@ def TestConnection(self):
             return True
         except Exception as ex:
             self.state.logging.RecordException(ex, "Rcon server test failed")
-            self.state.RecordActivity(str(ex))
+            self.state.RecordActivity(
+                self.state.translations.currentTexts["Rcon TestErrorMessage"] + str(ex))
             return False
 
     def SendCommand(self, commandString):

Source/Streamlabs Rcon Integration.py

@@ -12,12 +12,13 @@
 
 class State():
     def __init__(self):
+        self.version = "0.1.0"
         self.config = Config(self)
         self.logging = Logging(self)
         self.config.LogMissingSettings()
-        self.donationsIdsProcessed = {}
 
     def Setup(self):
+        self.donationsIdsProcessed = {}
         self.translations = Translations(self)
         self.currency = Currency(self)
         StreamlabsEvent.LoadEventDefinitions()
@@ -173,7 +174,7 @@ def UpdateStatus(self):
                 self.translations.currentTexts["Status Stopped"])
 
     def Run(self):
-        self.logging.DebugLog("App Started")
+        self.logging.Log("App Started")
         self.gui.mainloop()
 
 

Source/Translations.py

@@ -28,5 +28,6 @@ def GetLocalisedTexts(self, language):
                 "StreamlabsEvent NoProfileAction": "WARNING: no reaction found for event: ",
                 "StreamlabsEvent EventHandled": "Event Handled: ",
                 "Rcon CommandError": "ERROR: Rcon command failed, run manually: ",
-                "Rcon CommandResponseWarning": "WARNING: Rcon got response from server: "
+                "Rcon CommandResponseWarning": "WARNING: Rcon got response from server: ",
+                "Rcon TestErrorMessage": "Rcon connection test message: "
             }