Merge pull request #2882 from drunderscore/feature/detect-installatio…

…ns-in-client-directory

Detect invalid TShock installations

TShockLauncher/Program.cs

@@ -29,20 +29,38 @@ You should have received a copy of the GNU General Public License
 using System.Reflection;
 using TShockPluginManager;
 
+// On occasion, users have been seen extracting TShock into their client installation directory -- this is of course incorrect, and is known
+// to cause issues. Let's attempt to catch this before anything happens (specifically, before Terraria assemblies are resolved) and prevent
+// TShock from launching.
+if (File.Exists("TerrariaServer.exe"))
+{
+	Console.ForegroundColor = ConsoleColor.Red;
+	Console.Error.WriteLine("A \"TerrariaServer.exe\" file has been found in the current working directory.");
+	Console.Error.WriteLine(
+		"This indicates either installation into a Terraria client directory, or installation into a legacy (TShock 4 or older) TShock directory.");
+	Console.Error.WriteLine(
+		"TShock is never to be installed inside a Terraria client directory. You should instead extract your TShock installation into it's own directory.");
+	Console.Error.WriteLine(
+		"If you are updating a legacy TShock installation, please follow the following documentation to update: https://ikebukuro.tshock.co/#/?id=upgrading-from-tshock-4");
+	Console.Error.WriteLine("The launcher will now exit.");
+	Console.ResetColor();
+	return 1;
+}
+
 if (args.Length > 0 && args[0].ToLower() == "plugins")
 {
 	var items = args.ToList();
 	items.RemoveAt(0);
 	await NugetCLI.Main(items);
-	return;
+	return 0;
 }
 
 
 Dictionary<string, Assembly> _cache = new Dictionary<string, Assembly>();
 
 System.Runtime.Loader.AssemblyLoadContext.Default.Resolving += Default_Resolving;
 
-Start();
+return Start();
 
 /// <summary>
 /// Resolves a module from the ./bin folder, either with a .dll by preference or .exe
@@ -70,7 +88,8 @@ You should have received a copy of the GNU General Public License
 /// Initiates the TSAPI server.
 /// </summary>
 /// <remarks>This method exists so that the resolver can attach before TSAPI needs its dependencies.</remarks>
-void Start()
+int Start()
 {
 	TerrariaApi.Server.Program.Main(args);
+	return 0;
 }

docs/changelog.md

@@ -91,6 +91,8 @@ Use past tense when adding new entries; sign your name off when you add or chang
 * Fixed /help, /me, and /p commands can't work in non-English languages. (@ACaiCat)
 * Added a hook `AccountHooks.AccountGroupUpdate`, which is called when you change the user group. (@AgaSpace)
 * * Ensured `TSPlayer.PlayerData` is non-null whilst syncing loadouts. (@drunderscore)
+* * Detected invalid installations, by checking for a file named `TerrariaServer.exe`. (@drunderscore)
+  * This made the two most common installation mistakes (extracting into the Terraria client directory, and extracting TShock 5 or newer into a TShock 4 or older install) prompt the user with a more useful diagnostic, rather than (likely) crashing moments later.
 
 ## TShock 5.2.1
 * Updated `TSPlayer.GodMode`. (@AgaSpace)