From 4a26c96fbe600a4a229a1e63abb716a62dc7f450 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Thu, 16 Sep 2021 18:48:59 -0400
Subject: remove GameExecutableName build property from package

---
 build/find-game-folder.targets                     |  5 -----
 docs/technical/mod-package.md                      | 24 +++++++++++-----------
 src/SMAPI.ModBuildConfig/build/smapi.targets       |  4 ++--
 .../SMAPI.Mods.ConsoleCommands.csproj              |  2 +-
 .../SMAPI.Mods.ErrorHandler.csproj                 |  2 +-
 .../SMAPI.Mods.SaveBackup.csproj                   |  2 +-
 src/SMAPI.Tests/SMAPI.Tests.csproj                 |  5 +----
 src/SMAPI/SMAPI.csproj                             |  2 +-
 8 files changed, 19 insertions(+), 27 deletions(-)

diff --git a/build/find-game-folder.targets b/build/find-game-folder.targets
index 3341226d..3164b071 100644
--- a/build/find-game-folder.targets
+++ b/build/find-game-folder.targets
@@ -41,9 +41,4 @@
       </PropertyGroup>
     </When>
   </Choose>
-
-  <!-- set game metadata -->
-  <PropertyGroup>
-    <GameExecutableName>Stardew Valley</GameExecutableName>
-  </PropertyGroup>
 </Project>
diff --git a/docs/technical/mod-package.md b/docs/technical/mod-package.md
index 0fdd4c4a..5eff3d2e 100644
--- a/docs/technical/mod-package.md
+++ b/docs/technical/mod-package.md
@@ -29,7 +29,7 @@ change how these work):
 * **Detect game path:**  
   The package automatically finds your game folder by scanning the default install paths and
   Windows registry. It adds two MSBuild properties for use in your `.csproj` file if needed:
-  `$(GamePath)` and `$(GameExecutableName)`.
+  `$(GamePath)` and `$(GameModsPath)`.
 
 * **Add assembly references:**  
   The package adds assembly references to SMAPI, Stardew Valley, xTile, and the game framework
@@ -126,15 +126,6 @@ change it.
 The absolute path to the folder containing the game's installed mods (defaults to
 `$(GamePath)/Mods`), used when deploying the mod files.
 
-</td>
-</tr>
-<tr>
-<td><code>GameExecutableName</code></td>
-<td>
-
-The filename for the game's executable (i.e. `StardewValley.exe` on Linux/macOS or
-`Stardew Valley.exe` on Windows). This is auto-detected, and you should almost never change this.
-
 </td>
 </tr>
 <tr>
@@ -382,13 +373,21 @@ when you compile it.
 ## Upcoming release
 * Updated for Stardew Valley 1.5.5 and SMAPI 3.13.0. **Older versions are no longer supported.**
 * Added `IgnoreModFilePaths` option to ignore literal paths.
+* Removed the `GameExecutableName` build property (since it now has the same value on all platforms).
 * Improved analyzer performance by enabling parallel execution.
 
+**Migration guide for mod authors:**
+1. See [_migrate to 64-bit_](https://stardewvalleywiki.com/Modding:Migrate_to_64-bit_on_Windows) and
+   [_migrate to Stardew Valley 1.5.5_](https://stardewvalleywiki.com/Modding:Migrate_to_Stardew_Valley_1.5.5).
+2. Possible changes in your `.csproj` or `.targets` files:
+   * If you use `$(GameExecutableName)`, replace it with `Stardew Valley`.
+
 ## 3.3.0
 Released 30 March 2021.
 
 * Added a build warning when the mod isn't compiled for `Any CPU`.
-* Added a `GameFramework` build property set to `MonoGame` or `Xna` based on the platform. This can be overridden to change which framework it references.
+* Added a `GameFramework` build property set to `MonoGame` or `Xna` based on the platform. This can
+  be overridden to change which framework it references.
 * Added support for building mods against the 64-bit Linux version of the game on Windows.
 * The package now suppresses the misleading 'processor architecture mismatch' warnings.
 
@@ -396,7 +395,8 @@ Released 30 March 2021.
 Released 23 September 2020.
 
 * Reworked and streamlined how the package is compiled.
-* Added [SMAPI-ModTranslationClassBuilder](https://github.com/Pathoschild/SMAPI-ModTranslationClassBuilder) files to the ignore list.
+* Added [SMAPI-ModTranslationClassBuilder](https://github.com/Pathoschild/SMAPI-ModTranslationClassBuilder)
+  files to the ignore list.
 
 ### 3.2.1
 Released 11 September 2020.
diff --git a/src/SMAPI.ModBuildConfig/build/smapi.targets b/src/SMAPI.ModBuildConfig/build/smapi.targets
index b254dd7c..6fc62046 100644
--- a/src/SMAPI.ModBuildConfig/build/smapi.targets
+++ b/src/SMAPI.ModBuildConfig/build/smapi.targets
@@ -48,7 +48,7 @@
   **********************************************-->
   <ItemGroup>
     <!-- game -->
-    <Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="$(CopyModReferencesToBuildOutput)" />
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="$(CopyModReferencesToBuildOutput)" />
     <Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="$(CopyModReferencesToBuildOutput)" />
     <Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="$(CopyModReferencesToBuildOutput)" />
     <Reference Include="xTile" HintPath="$(GamePath)\xTile.dll" Private="$(CopyModReferencesToBuildOutput)" />
@@ -71,7 +71,7 @@
 
     <!-- invalid game path -->
     <Error Condition="!Exists('$(GamePath)')" Text="The mod build package can't find your game folder. You can specify where to find it; see https://smapi.io/package/custom-game-path." ContinueOnError="false" />
-    <Error Condition="!Exists('$(GamePath)\$(GameExecutableName).dll')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain the $(GameExecutableName) file. If this folder is invalid, delete it and the package will autodetect another game install path." ContinueOnError="false" />
+    <Error Condition="!Exists('$(GamePath)\Stardew Valley.dll')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain the Stardew Valley file. If this folder is invalid, delete it and the package will autodetect another game install path." ContinueOnError="false" />
     <Error Condition="!Exists('$(GamePath)\StardewModdingAPI.dll')" Text="The mod build package found a game folder at $(GamePath), but it doesn't contain SMAPI. You need to install SMAPI before building the mod." ContinueOnError="false" />
 
     <!-- invalid target architecture (note: internal value is 'AnyCPU', value shown in Visual Studio is 'Any CPU') -->
diff --git a/src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj b/src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj
index 65d54599..52439c41 100644
--- a/src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj
+++ b/src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj
@@ -13,8 +13,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
     <Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="False" />
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
     <Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
   </ItemGroup>
 
diff --git a/src/SMAPI.Mods.ErrorHandler/SMAPI.Mods.ErrorHandler.csproj b/src/SMAPI.Mods.ErrorHandler/SMAPI.Mods.ErrorHandler.csproj
index 2ad19df7..78cdb315 100644
--- a/src/SMAPI.Mods.ErrorHandler/SMAPI.Mods.ErrorHandler.csproj
+++ b/src/SMAPI.Mods.ErrorHandler/SMAPI.Mods.ErrorHandler.csproj
@@ -14,8 +14,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
     <Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="False" />
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
     <Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
     <Reference Include="xTile" HintPath="$(GamePath)\xTile.dll" Private="False" />
   </ItemGroup>
diff --git a/src/SMAPI.Mods.SaveBackup/SMAPI.Mods.SaveBackup.csproj b/src/SMAPI.Mods.SaveBackup/SMAPI.Mods.SaveBackup.csproj
index f8908c7d..a8b0dfdb 100644
--- a/src/SMAPI.Mods.SaveBackup/SMAPI.Mods.SaveBackup.csproj
+++ b/src/SMAPI.Mods.SaveBackup/SMAPI.Mods.SaveBackup.csproj
@@ -13,7 +13,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/SMAPI.Tests/SMAPI.Tests.csproj b/src/SMAPI.Tests/SMAPI.Tests.csproj
index e19105ff..8329b2e1 100644
--- a/src/SMAPI.Tests/SMAPI.Tests.csproj
+++ b/src/SMAPI.Tests/SMAPI.Tests.csproj
@@ -23,10 +23,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Reference Include="$(GameExecutableName)">
-      <HintPath>$(GamePath)\$(GameExecutableName).dll</HintPath>
-      <Private>True</Private>
-    </Reference>
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="True" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/SMAPI/SMAPI.csproj b/src/SMAPI/SMAPI.csproj
index 16ddb92a..4f9aa9b1 100644
--- a/src/SMAPI/SMAPI.csproj
+++ b/src/SMAPI/SMAPI.csproj
@@ -29,7 +29,7 @@
 
   <ItemGroup>
     <Reference Include="..\..\build\0Harmony.dll" Private="True" />
-    <Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
+    <Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
     <Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
     <Reference Include="GalaxyCSharp" HintPath="$(GamePath)\GalaxyCSharp.dll" Private="False" />
     <Reference Include="Lidgren.Network" HintPath="$(GamePath)\Lidgren.Network.dll" Private="False" />
-- 
cgit