From 98d01d522d488192b5d5da50d70752a8c0739a94 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 5 Dec 2021 00:51:24 -0500
Subject: improve error when installer is pointed at a compatibility-branch
 game folder

---
 src/SMAPI.Installer/Framework/InstallerContext.cs |  6 +--
 src/SMAPI.Installer/InteractiveInstaller.cs       | 65 +++++++++++++++++------
 2 files changed, 51 insertions(+), 20 deletions(-)

(limited to 'src/SMAPI.Installer')

diff --git a/src/SMAPI.Installer/Framework/InstallerContext.cs b/src/SMAPI.Installer/Framework/InstallerContext.cs
index 68df2001..bb973230 100644
--- a/src/SMAPI.Installer/Framework/InstallerContext.cs
+++ b/src/SMAPI.Installer/Framework/InstallerContext.cs
@@ -55,11 +55,11 @@ namespace StardewModdingAPI.Installer.Framework
             return this.GameScanner.LooksLikeGameFolder(dir);
         }
 
-        /// <summary>Get whether a folder seems to contain Stardew Valley 1.5.4 or earlier.</summary>
+        /// <summary>Get whether a folder seems to contain the game, and which version it contains if so.</summary>
         /// <param name="dir">The folder to check.</param>
-        public bool LooksLikeStardewValley154(DirectoryInfo dir)
+        public GameFolderType GetGameFolderType(DirectoryInfo dir)
         {
-            return this.GameScanner.LooksLikeStardewValley154(dir);
+            return this.GameScanner.GetGameFolderType(dir);
         }
     }
 }
diff --git a/src/SMAPI.Installer/InteractiveInstaller.cs b/src/SMAPI.Installer/InteractiveInstaller.cs
index 424fe42b..6694c257 100644
--- a/src/SMAPI.Installer/InteractiveInstaller.cs
+++ b/src/SMAPI.Installer/InteractiveInstaller.cs
@@ -10,6 +10,7 @@ using StardewModdingAPI.Installer.Framework;
 using StardewModdingAPI.Internal.ConsoleWriting;
 using StardewModdingAPI.Toolkit;
 using StardewModdingAPI.Toolkit.Framework;
+using StardewModdingAPI.Toolkit.Framework.GameScanning;
 using StardewModdingAPI.Toolkit.Framework.ModScanning;
 using StardewModdingAPI.Toolkit.Utilities;
 
@@ -633,18 +634,39 @@ namespace StardewModdingApi.Installer
             // use specified path
             if (specifiedPath != null)
             {
+                string errorPrefix = $"You specified --game-path \"{specifiedPath}\", but";
+
                 var dir = new DirectoryInfo(specifiedPath);
                 if (!dir.Exists)
                 {
-                    this.PrintError($"You specified --game-path \"{specifiedPath}\", but that folder doesn't exist.");
+                    this.PrintError($"{errorPrefix} that folder doesn't exist.");
                     return null;
                 }
-                if (!context.LooksLikeGameFolder(dir))
+
+                switch (context.GetGameFolderType(dir))
                 {
-                    this.PrintError($"You specified --game-path \"{specifiedPath}\", but that folder doesn't contain the Stardew Valley executable.");
-                    return null;
+                    case GameFolderType.Valid:
+                        return dir;
+
+                    case GameFolderType.Legacy154OrEarlier:
+                        this.PrintWarning($"{errorPrefix} that directory seems to have Stardew Valley 1.5.4 or earlier.");
+                        this.PrintWarning("Please update your game to the latest version to use SMAPI.");
+                        return null;
+
+                    case GameFolderType.LegacyCompatibilityBranch:
+                        this.PrintWarning($"{errorPrefix} that directory seems to have the Stardew Valley legacy 'compatibility' branch.");
+                        this.PrintWarning("Unfortunately SMAPI is only compatible with the full main version of the game.");
+                        this.PrintWarning("Please update your game to the main branch to use SMAPI.");
+                        return null;
+
+                    case GameFolderType.NoGameFound:
+                        this.PrintWarning($"{errorPrefix} that directory doesn't contain a Stardew Valley executable.");
+                        return null;
+
+                    default:
+                        this.PrintWarning($"{errorPrefix} that directory doesn't seem to contain a valid game install.");
+                        return null;
                 }
-                return dir;
             }
 
             // let user choose detected path
@@ -702,23 +724,32 @@ namespace StardewModdingApi.Installer
                     this.PrintWarning("That directory doesn't seem to exist.");
                     continue;
                 }
-                if (!context.LooksLikeGameFolder(directory))
+
+                switch (context.GetGameFolderType(directory))
                 {
-                    if (context.LooksLikeStardewValley154(directory))
-                    {
+                    case GameFolderType.Valid:
+                        this.PrintInfo("   OK!");
+                        return directory;
+
+                    case GameFolderType.Legacy154OrEarlier:
                         this.PrintWarning("That directory seems to have Stardew Valley 1.5.4 or earlier.");
                         this.PrintWarning("Please update your game to the latest version to use SMAPI.");
-                    }
-                    else
-                    {
+                        continue;
+
+                    case GameFolderType.LegacyCompatibilityBranch:
+                        this.PrintWarning("That directory seems to have the Stardew Valley legacy 'compatibility' branch.");
+                        this.PrintWarning("Unfortunately SMAPI is only compatible with the full main version of the game.");
+                        this.PrintWarning("Please update your game to the main branch to use SMAPI.");
+                        continue;
+
+                    case GameFolderType.NoGameFound:
                         this.PrintWarning("That directory doesn't contain a Stardew Valley executable.");
-                    }
-                    continue;
-                }
+                        continue;
 
-                // looks OK
-                this.PrintInfo("   OK!");
-                return directory;
+                    default:
+                        this.PrintWarning("That directory doesn't seem to contain a valid game install.");
+                        continue;
+                }
             }
         }
 
-- 
cgit