Added --data-path and --game-path options (SubnauticaNitrox#2522)

Author: Measurity

Nitrox.Server.Subnautica/Program.cs

@@ -26,7 +26,7 @@ namespace Nitrox.Server.Subnautica;
 [SuppressMessage("Usage", "DIMA001:Dependency Injection container is used directly")]
 public class Program
 {
-    private static Lazy<string> gameInstallDir;
+    private static Lazy<string>? gameInstallDir;
     private static readonly CircularBuffer<string> inputHistory = new(1000);
     private static int currentHistoryIndex;
     private static readonly CancellationTokenSource serverCts = new();
@@ -84,19 +84,7 @@ private static async Task StartServer(string[] args)
             Stopwatch watch = Stopwatch.StartNew();
 
             // Allow game path to be given as command argument
-            string gameDir;
-            if (args.Length > 0 && Directory.Exists(args[0]) && File.Exists(Path.Combine(args[0], GameInfo.Subnautica.ExeName)))
-            {
-                gameDir = Path.GetFullPath(args[0]);
-                gameInstallDir = new Lazy<string>(() => gameDir);
-            }
-            else
-            {
-                gameInstallDir = new Lazy<string>(() =>
-                {
-                    return gameDir = NitroxUser.GamePath;
-                });
-            }
+            gameInstallDir = new Lazy<string>(() => NitroxUser.GamePath);
             Log.Info($"Using game files from: \'{gameInstallDir.Value}\'");
 
             // TODO: Fix DI to not be slow (should not use IO in type constructors). Instead, use Lazy<T> (et al). This way, cancellation can be faster.
@@ -107,7 +95,7 @@ private static async Task StartServer(string[] args)
             {
                 _ = ipc.SendOutput($"{Ipc.Messages.PlayerCountMessage}:[{count}]");
             };
-            string serverSaveName = NitroxServer.Server.GetSaveName(args, "My World");
+            string serverSaveName = NitroxServer.Server.GetSaveName(args);
             Log.SaveName = serverSaveName;
 
             using (CancellationTokenSource portWaitCts = CancellationTokenSource.CreateLinkedTokenSource(serverCts.Token))
@@ -525,11 +513,11 @@ private static void CurrentDomainOnUnhandledException(object sender, UnhandledEx
     private static class AssemblyResolver
     {
         private static string currentExecutableDirectory;
-        private static readonly Dictionary<string, Assembly> resolvedAssemblyCache = [];
+        private static readonly Dictionary<string, AssemblyCacheEntry> resolvedAssemblyCache = [];
 
-        public static Assembly Handler(object sender, ResolveEventArgs args)
+        public static Assembly? Handler(object sender, ResolveEventArgs args)
         {
-            static Assembly ResolveFromLib(ReadOnlySpan<char> dllName)
+            static Assembly? ResolveFromLib(ReadOnlySpan<char> dllName)
             {
                 dllName = dllName.Slice(0, Math.Max(dllName.IndexOf(','), 0));
                 if (dllName.IsEmpty)
@@ -546,35 +534,48 @@ static Assembly ResolveFromLib(ReadOnlySpan<char> dllName)
                 }
                 string dllNameStr = dllName.ToString();
                 // If available, return cached assembly
-                if (resolvedAssemblyCache.TryGetValue(dllNameStr, out Assembly val))
+                if (resolvedAssemblyCache.TryGetValue(dllNameStr, out AssemblyCacheEntry cacheEntry) && cacheEntry is { Assembly: { } cachedAssembly })
                 {
-                    return val;
+                    return cachedAssembly;
+                }
+                if (cacheEntry == null)
+                {
+                    cacheEntry = new AssemblyCacheEntry(0, null);
+                    resolvedAssemblyCache[dllNameStr] = cacheEntry;
                 }
 
                 // Load DLLs where this program (exe) is located
                 string dllPath = Path.Combine(GetExecutableDirectory(), "lib", dllNameStr);
                 // Prefer to use Newtonsoft dll from game instead of our own due to protobuf issues. TODO: Remove when we do our own deserialization of game data instead of using the game's protobuf.
                 if (dllPath.IndexOf("Newtonsoft.Json.dll", StringComparison.OrdinalIgnoreCase) >= 0 || !File.Exists(dllPath))
                 {
-                    // Try find game managed libraries
-                    if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+                    if (gameInstallDir != null)
                     {
-                        dllPath = Path.Combine(gameInstallDir.Value, "Resources", "Data", "Managed", dllNameStr);
-                    }
-                    else
-                    {
-                        dllPath = Path.Combine(gameInstallDir.Value, "Subnautica_Data", "Managed", dllNameStr);
+                        // Try find game managed libraries
+                        if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+                        {
+                            dllPath = Path.Combine(gameInstallDir.Value, "Resources", "Data", "Managed", dllNameStr);
+                        }
+                        else
+                        {
+                            dllPath = Path.Combine(gameInstallDir.Value, "Subnautica_Data", "Managed", dllNameStr);
+                        }
                     }
                 }
 
                 try
                 {
                     // Read assemblies as bytes as to not lock the file so that Nitrox can patch assemblies while server is running.
-                    Assembly assembly = Assembly.Load(File.ReadAllBytes(dllPath));
-                    return resolvedAssemblyCache[dllNameStr] = assembly;
+                    cacheEntry.Assembly = Assembly.Load(File.ReadAllBytes(dllPath));
+                    return cacheEntry.Assembly;
                 }
                 catch
                 {
+                    cacheEntry.Attempts++;
+                    if (cacheEntry.Attempts >= 5)
+                    {
+                        throw new FileNotFoundException($"Failed to load DLL '{dllName}' at: {dllPath}");
+                    }
                     return null;
                 }
             }
@@ -602,5 +603,11 @@ private static string GetExecutableDirectory()
             }
             return currentExecutableDirectory = new Uri(Path.GetDirectoryName(pathAttempt ?? ".") ?? Directory.GetCurrentDirectory()).LocalPath;
         }
+
+        private record AssemblyCacheEntry(int Attempts, Assembly? Assembly)
+        {
+            public int Attempts { get; set; } = Attempts;
+            public Assembly? Assembly { get; set; } = Assembly;
+        }
     }
 }

NitroxModel/Core/NitroxEnvironment.cs

@@ -1,6 +1,8 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.InteropServices;
 
 namespace NitroxModel.Helper;
 
@@ -87,7 +89,24 @@ public static bool IsReleaseMode
     /// <summary>
     ///     Gets the command line arguments as passed to the program on start.
     /// </summary>
-    public static string[] CommandLineArgs => commandLineArgs ??= Environment.GetCommandLineArgs().Skip(1).ToArray();
+    public static string[] CommandLineArgs
+    {
+        get
+        {
+            if (commandLineArgs != null)
+            {
+                return commandLineArgs;
+            }
+
+            IEnumerable<string> args = Environment.GetCommandLineArgs().Skip(1);
+            // Windows removes the ' character around an arg but other OSes do not.
+            if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                args = args.Select(p => p.Trim('\''));
+            }
+            return commandLineArgs ??= args.ToArray();
+        }
+    }
 
     public static string AppName => (Assembly.GetEntryAssembly()?.GetName().Name ?? Assembly.GetCallingAssembly().GetName().Name).Replace(".", " ");
 

NitroxModel/Helper/NitroxUser.cs

@@ -83,6 +83,13 @@ public static string AppDataPath
                 }
             }
 
+            string? cliDataPath = NitroxEnvironment.CommandLineArgs.GetCommandArgs("--data-path").FirstOrDefault();
+            if (!string.IsNullOrWhiteSpace(cliDataPath) && Path.IsPathRooted(cliDataPath))
+            {
+                Directory.CreateDirectory(cliDataPath);
+                return appDataPath = cliDataPath;
+            }
+
             if (!Directory.Exists(applicationData))
             {
                 applicationData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
@@ -164,6 +171,17 @@ public static string GamePath
                 return gamePath;
             }
 
+            string? cliGamePath = NitroxEnvironment.CommandLineArgs.GetCommandArgs("--game-path").FirstOrDefault();
+            if (Directory.Exists(cliGamePath) && Path.IsPathRooted(cliGamePath))
+            {
+                GamePlatform = GamePlatforms.GetPlatformByGameDir(cliGamePath);
+                return gamePath = cliGamePath;
+            }
+            if (cliGamePath != null)
+            {
+                throw new DirectoryNotFoundException($"Game directory not found at user-specified location: {cliGamePath}");
+            }
+
             List<GameFinderResult> finderResults = GameInstallationFinder.Instance.FindGame(GameInfo.Subnautica).TakeUntilInclusive(r => r is { IsOk: false }).ToList();
             GameFinderResult potentiallyValidResult = finderResults.LastOrDefault();
             if (potentiallyValidResult?.IsOk == true)

NitroxServer/Server.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Net;
@@ -135,7 +136,7 @@ public static SubnauticaServerConfig CreateOrLoadConfig()
         {
             // Create new save file
             Log.Debug("No save file was found, creating a new one...");
-            saveDir = Path.Combine(KeyValueStore.Instance.GetSavesFolderDir(), "My World");
+            saveDir = Path.Combine(KeyValueStore.Instance.GetSavesFolderDir(), GetSaveName(NitroxEnvironment.CommandLineArgs));
             Directory.CreateDirectory(saveDir);
         }
 
@@ -368,13 +369,13 @@ private static List<ServerListing> GetSaves()
     ///     Parses the save name from the given command line arguments or defaults to the standard save name.
     /// </summary>
     // TODO : Remove this method once server hosting/loading happens as a service (see '.NET Generic Host' on msdn)
-    public static string GetSaveName(string[] args, string defaultValue = null)
+    public static string GetSaveName(string[] args, string defaultValue = "My World")
     {
-        string result = args.GetCommandArgs("--save").FirstOrDefault() ?? args.GetCommandArgs("--name").FirstOrDefault();
+        string? result = args.GetCommandArgs("--save").FirstOrDefault() ?? args.GetCommandArgs("--name").FirstOrDefault();
         return IsValidSaveName(result) ? result : defaultValue;
     }
 
-    private static bool IsValidSaveName(string name)
+    private static bool IsValidSaveName([NotNullWhen(true)] string? name)
     {
         if (string.IsNullOrWhiteSpace(name))
         {
@@ -384,11 +385,11 @@ private static bool IsValidSaveName(string name)
         {
             return false;
         }
-        if (name.EndsWith("."))
+        if (name.EndsWith('.'))
         {
             return false;
         }
-        if (name.IndexOfAny(Path.GetInvalidFileNameChars().ToArray()) > -1)
+        if (name.IndexOfAny(Path.GetInvalidFileNameChars()) > -1)
         {
             return false;
         }