More fixes and documentation. Should be ready for release now.

Author: CaiB

README.md

@@ -31,14 +31,32 @@ Prerequisite: [.NET 6](https://dotnet.microsoft.com/en-us/)
 - Make sure the service shows as `Running`, and you receive no errors trying to start it.
 - Your Minecraft server should be running. You're done!
 
-You can install multiple servers, by reusing the same SMSM files, and simply creating another `config.json` pointing to a different server. Just repeat the above steps for the second config.
+You can install multiple servers, by reusing the same SMSM files, and simply creating another config `.json` pointing to a different server. Just repeat the above steps for the second config.
 
 ## Management
-To manage the server, start the management utility from an **administrator** PowerShell window: `.\SMSMRemoteTool.exe <Name>`, where `Name` is the name used to install the service (should be the `Name` in the `config.json`).  
+To manage the server, start the management utility from an **administrator** PowerShell window: `.\SMSMRemoteTool.exe <Name>`, where `Name` is the name used to install the service (should be the `Name` in the config `.json`).  
 If you are successfully connected, you should see `-> Connected to management interface on "<Name>".`
 You can now enter any command from the section below.  
 Once you are done, type `exit` and press enter. This stops the remote session, but does **not** turn off the server. To completely shut down the server, use the `stop` command, and then stop the service.
 
+## Configuration
+All settings are configured in the config `.json` file you selected when installing the service. The below table explains the options available.
+
+| Option | Required? | Default | Type | Description |
+|---|---|---|---|---|
+| `Name` | **Required** | N/A | string | The name of this instance. Used to name the service, access the management interface, and in various other locations.  A name without spaces is recommended. |
+| `ServerDir` | **Required** | N/A | Path string | The location of the Minecraft server files. The server JAR should be located in this folder. |
+| `JavaPath` | Recommended | Java on PATH | Path string | A path to `java.exe`, including the filename. If not specified, SMSM attempts to use your system default Java installation, which may be incorrect, so it is recommended to set this. |
+| `MinRAM` | Optional | 1024 | int | The amount of RAM to assign as the minimum, in MB. |
+| `MaxRAM` | Optional | 2048 | int | The amount of RAM to assign as the maximum, in MB. |
+| `JavaArgs` | Optional | `""` | string | Additional arguments to pass to Java (not the server). |
+| `ServerJar` | **Required** | N/A | string | The name of the server JAR file. Do not include the path. |
+| `ServerArgs` | Optional | `""` | string | Additional arguments to pass to the server (not Java). |
+| `AutoStart` | Optional | `true` | bool | Whether to start the Minecraft server when SMSM starts. |
+| `BackupsToKeep` | Optional | `20` | int | The number of backup ZIP files to keep. If there are more than this number, the oldest ones will be deleted until this number is reached. |
+| `BackupExclusions` | Optional | None | string array | A list of non-case-sensitive exclusion patterns for files and directories to exclude from being backed up. Wildcards are supported, such as `?`,`*`,`**`. |
+| `Schedule` | Optional | None | object array | A list of scheduled tasks that SMSM will do, regardless of whether the Minecraft server is running or not. See the below section for further details. |
+
 ## Commands
 These are used both by the remote management tool, and by the task scheduler.
 | Task | Argument | Description |

SMSMService/ConfigReader.cs

@@ -21,6 +21,7 @@ public static bool ReadConfig(string path)
         string JavaArgs = ReadProperty(JSON, "JavaArgs", "", false);
         string? ServerJar = ReadProperty<string?>(JSON, "ServerJar", null, true);
         string ServerArgs = ReadProperty(JSON, "ServerArgs", "", false);
+        bool AutoStart = ReadProperty(JSON, "AutoStart", true, false);
         int BackupsToKeep = ReadProperty(JSON, "BackupsToKeep", 20, true);
         string[] BackupExclusions = ReadArray(JSON, "BackupExclusions", Array.Empty<string>(), false);
 
@@ -117,6 +118,7 @@ public static bool ReadConfig(string path)
         SMSM.JavaArgs = Arguments;
         SMSM.ServerDir = ServerDir;
         SMSM.ServerName = Name;
+        SMSM.AutoStart = AutoStart;
         Scheduler.Tasks = Schedule;
         BackupTask.MaxBackupCount = BackupsToKeep;
         BackupTask.Exclusions = BackupExclusions;
@@ -133,8 +135,11 @@ public static bool ReadConfig(string path)
     /// <returns>A property value, either from JSON or the default</returns>
     private static T ReadProperty<T>(JObject source, string name, T defaultValue, bool warnIfNotFound)
     {
-        T? Result = source.Value<T>(name);
-        if (Result != null) { return Result; }
+        if (source.ContainsKey(name))
+        {
+            T? Result = source.Value<T>(name);
+            if (Result != null) { return Result; }
+        }
 
         if (warnIfNotFound) { Log.Warn($"'{name}' was not found in the config file. Using defautl value of '{defaultValue}'."); }
         return defaultValue;

SMSMService/SMSM.cs

@@ -1,4 +1,5 @@
-using SMSMService.Tasks;
+using Microsoft.Extensions.Hosting.WindowsServices;
+using SMSMService.Tasks;
 
 namespace SMSMService;
 public class SMSM : BackgroundService
@@ -9,43 +10,75 @@ public class SMSM : BackgroundService
     public static string? JavaArgs;
     public static string? ServerDir;
     public static string ServerName = "No Name";
+    public static bool AutoStart = true;
 
     private readonly ILogger<SMSM> Logger;
+    private readonly IHostApplicationLifetime Lifetime;
 
-    public SMSM(ILogger<SMSM> logger)
+    public SMSM(ILogger<SMSM> logger, IHostApplicationLifetime lifetime)
     {
         this.Logger = logger;
+        this.Lifetime = lifetime;
+        this.Lifetime.ApplicationStopping.Register(Stop);
+        if (this.Lifetime is WindowsServiceLifetime ServiceLife)
+        {
+            ServiceLife.CanStop = true;
+            ServiceLife.CanShutdown = true;
+        }
     }
 
-    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
+    protected override async Task ExecuteAsync(CancellationToken stoppingToken) => await Task.Run(async () =>
     {
-        TaskHandler.AddTasks();
-
-        if (ConfigFile == null) { return; }
-        bool ConfigResult = ConfigReader.ReadConfig(ConfigFile);
-        if (!ConfigResult)
+        try
         {
-            Log.Error("The configuration could not be parsed, and SMSM will now exit.");
-            Environment.Exit(-2);
-        }
-        BackupTask.Init();
+            TaskHandler.AddTasks();
 
-        Scheduler.Start();
+            if (ConfigFile == null) { return; }
+            bool ConfigResult = ConfigReader.ReadConfig(ConfigFile);
+            if (!ConfigResult)
+            {
+                Log.Error("The configuration could not be parsed, and SMSM will now exit.");
+                Environment.Exit(-2);
+            }
+            BackupTask.Init();
 
-        RemoteConnector.Start(ServerName);
+            Scheduler.Start();
 
-        while (!stoppingToken.IsCancellationRequested)
-        {
-            await Task.Delay(1000, stoppingToken);
+            RemoteConnector.Start(ServerName);
+
+            if (AutoStart)
+            {
+                bool Started = Server.StartServer();
+                if (!Started) { Log.Error("Server could not be auto-started."); }
+            }
+
+            while (!stoppingToken.IsCancellationRequested)
+            {
+                await Task.Delay(1000, stoppingToken);
+            }
         }
+        catch (Exception Exc) { Log.Error(Exc.ToString()); }
+        finally { Stop(); }
+    });
+
+    public override async Task StopAsync(CancellationToken stoppingToken)
+    {
+        Stop();
+        await base.StopAsync(stoppingToken);
     }
 
     public static void Stop()
     {
         Log.Info("SMSM exit requested.");
+        Server.SendInput("/say Server shutting down because the management service is stopping");
+        Server.SendInput("/save-all");
         Server.SendInput("/stop");
+        Server.WaitForExit();
         RemoteConnector.Stop();
         Scheduler.Stop();
+        Log.Info("SMSM exit completed.");
     }
-    
+
+    public static void OnShutdown() => Stop();
+
 }

SMSMService/Start.cs

@@ -6,12 +6,14 @@ public static async Task Main(string[] args)
     {
         if (args.Length != 1) { Console.WriteLine("Please specify the config file path as command-line argument."); Environment.Exit(-3); }
         SMSM.ConfigFile = args[0];
+        //Console.TreatControlCAsInput = true;
 
         IHost host = Host.CreateDefaultBuilder(args)
         .UseWindowsService(options =>
         {
             options.ServiceName = "SMSM Minecraft Server";
         })
+        .ConfigureHostOptions(options => options.ShutdownTimeout = TimeSpan.FromSeconds(60))
         .ConfigureServices(services =>
         {
             services.AddHostedService<SMSM>();