Fix remote tool not exiting, log file location, fix backups failing after server stops. Updated docs. Ready to release v1.1.

Author: CaiB

README.md

@@ -153,4 +153,11 @@ Every Wednesday at 01:50, except if it is the 1st of the month:
         "Weekdays": "All"
     }
 ]
-```
+```
+
+
+### Known Issues
+- Starting the remote tool before the SMSM service is ready will cause it to connect, but will not be able to send commands, and will cause the service to lose its server process.
+    - Recommended workaround: Do not start the remote tool when the SMSM service isn't running.
+- The service does not gracefully shut down the Minecraft server if Windows is shutting down.
+    - Recommended workaround: Stop the server via the remote tool, or stop the service via `services.msc` before shutting down or restarting Windows.

SMSMRemoteTool/SMSMRemoteTool.cs

@@ -39,6 +39,7 @@ public static void Main(string[] args)
             }
             PipeRW.WriteLine(UserInput);
         }
+        Stop();
     }
 
     public static void Stop()

SMSMRemoteTool/SMSMRemoteTool.csproj

@@ -5,6 +5,7 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <AssemblyVersion>1.1.0.0</AssemblyVersion>
   </PropertyGroup>
 
 </Project>

SMSMService/SMSMService.csproj

@@ -5,6 +5,7 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <UserSecretsId>dotnet-WorkerSvc-AF94159C-698F-409B-B8C8-C875CA76A729</UserSecretsId>
+    <AssemblyVersion>1.1.0.0</AssemblyVersion>
   </PropertyGroup>
 
   <ItemGroup>

SMSMService/Server.cs

@@ -29,9 +29,9 @@ public static bool StartServer()
             ServerProc.OutputDataReceived += ServerOutputHandler;
             ServerProc.ErrorDataReceived += ServerErrorHandler;
             ServerProc.Start();
+            ServerReady = true;
             ServerProc.BeginOutputReadLine();
             ServerProc.BeginErrorReadLine();
-            ServerReady = true;
             Log.Info($"Server process started as PID {ServerProc.Id}");
             return true;
         }
@@ -64,6 +64,7 @@ public static void KillServer()
 
     private static void ServerExitHandler(object? sender, EventArgs evt)
     {
+        ServerReady = false;
         Log.Info("Server process exited.");
         if (ServerProc != null && ServerProc.HasExited) { ServerProc = null; }
     }

SMSMService/Start.cs

@@ -8,7 +8,14 @@ public static async Task Main(string[] args)
         SMSM.ConfigFile = args[0];
 
         string LogDate = DateTime.Now.ToString("yyyy-MM-dd\\_HH-mm-ss");
-        try { Log.LogFile = new StreamWriter(File.Create($"C:\\Games\\Minecraft\\LTS\\SMSMLog-{LogDate}.txt")) { AutoFlush = true }; }
+        try
+        {
+            string ExePath = AppDomain.CurrentDomain.BaseDirectory ?? "";
+            string LogFileName = $"SMSMLog-{Environment.UserName}-{LogDate}.txt";
+            string LogFilePath = Path.Combine(ExePath, LogFileName);
+            Log.Info($"Attempting to log to \"{LogFilePath}\"");
+            Log.LogFile = new StreamWriter(File.Create(LogFilePath)) { AutoFlush = true };
+        }
         catch (Exception Exc)
         {
             Log.Error("Could not create log file.");