Skip to content

Commit 4a26c96

Browse files
PathoschildPathoschild
committed
remove GameExecutableName build property from package
1 parent 217cc7a commit 4a26c96

8 files changed

Lines changed: 19 additions & 27 deletions

File tree

‎build/find-game-folder.targets‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,4 @@
4141
</PropertyGroup>
4242
</When>
4343
</Choose>
44-
45-
<!-- set game metadata -->
46-
<PropertyGroup>
47-
<GameExecutableName>Stardew Valley</GameExecutableName>
48-
</PropertyGroup>
4944
</Project>

‎docs/technical/mod-package.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ change how these work):
2929
* **Detect game path:**
3030
The package automatically finds your game folder by scanning the default install paths and
3131
Windows registry. It adds two MSBuild properties for use in your `.csproj` file if needed:
32-
`$(GamePath)` and `$(GameExecutableName)`.
32+
`$(GamePath)` and `$(GameModsPath)`.
3333

3434
* **Add assembly references:**
3535
The package adds assembly references to SMAPI, Stardew Valley, xTile, and the game framework
@@ -126,15 +126,6 @@ change it.
126126
The absolute path to the folder containing the game's installed mods (defaults to
127127
`$(GamePath)/Mods`), used when deploying the mod files.
128128

129-
</td>
130-
</tr>
131-
<tr>
132-
<td><code>GameExecutableName</code></td>
133-
<td>
134-
135-
The filename for the game's executable (i.e. `StardewValley.exe` on Linux/macOS or
136-
`Stardew Valley.exe` on Windows). This is auto-detected, and you should almost never change this.
137-
138129
</td>
139130
</tr>
140131
<tr>
@@ -382,21 +373,30 @@ when you compile it.
382373
## Upcoming release
383374
* Updated for Stardew Valley 1.5.5 and SMAPI 3.13.0. **Older versions are no longer supported.**
384375
* Added `IgnoreModFilePaths` option to ignore literal paths.
376+
* Removed the `GameExecutableName` build property (since it now has the same value on all platforms).
385377
* Improved analyzer performance by enabling parallel execution.
386378

379+
**Migration guide for mod authors:**
380+
1. See [_migrate to 64-bit_](https://stardewvalleywiki.com/Modding:Migrate_to_64-bit_on_Windows) and
381+
[_migrate to Stardew Valley 1.5.5_](https://stardewvalleywiki.com/Modding:Migrate_to_Stardew_Valley_1.5.5).
382+
2. Possible changes in your `.csproj` or `.targets` files:
383+
* If you use `$(GameExecutableName)`, replace it with `Stardew Valley`.
384+
387385
## 3.3.0
388386
Released 30 March 2021.
389387

390388
* Added a build warning when the mod isn't compiled for `Any CPU`.
391-
* Added a `GameFramework` build property set to `MonoGame` or `Xna` based on the platform. This can be overridden to change which framework it references.
389+
* Added a `GameFramework` build property set to `MonoGame` or `Xna` based on the platform. This can
390+
be overridden to change which framework it references.
392391
* Added support for building mods against the 64-bit Linux version of the game on Windows.
393392
* The package now suppresses the misleading 'processor architecture mismatch' warnings.
394393

395394
## 3.2.2
396395
Released 23 September 2020.
397396

398397
* Reworked and streamlined how the package is compiled.
399-
* Added [SMAPI-ModTranslationClassBuilder](https://github.com/Pathoschild/SMAPI-ModTranslationClassBuilder) files to the ignore list.
398+
* Added [SMAPI-ModTranslationClassBuilder](https://github.com/Pathoschild/SMAPI-ModTranslationClassBuilder)
399+
files to the ignore list.
400400

401401
### 3.2.1
402402
Released 11 September 2020.

‎src/SMAPI.ModBuildConfig/build/smapi.targets‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
**********************************************-->
4949
<ItemGroup>
5050
<!-- game -->
51-
<Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="$(CopyModReferencesToBuildOutput)" />
51+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="$(CopyModReferencesToBuildOutput)" />
5252
<Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="$(CopyModReferencesToBuildOutput)" />
5353
<Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="$(CopyModReferencesToBuildOutput)" />
5454
<Reference Include="xTile" HintPath="$(GamePath)\xTile.dll" Private="$(CopyModReferencesToBuildOutput)" />
@@ -71,7 +71,7 @@
7171

7272
<!-- invalid game path -->
7373
<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" />
74-
<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" />
74+
<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" />
7575
<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" />
7676

7777
<!-- invalid target architecture (note: internal value is 'AnyCPU', value shown in Visual Studio is 'Any CPU') -->

‎src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
</ItemGroup>
1414

1515
<ItemGroup>
16-
<Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
1716
<Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="False" />
17+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
1818
<Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
1919
</ItemGroup>
2020

‎src/SMAPI.Mods.ErrorHandler/SMAPI.Mods.ErrorHandler.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
</ItemGroup>
1515

1616
<ItemGroup>
17-
<Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
1817
<Reference Include="MonoGame.Framework" HintPath="$(GamePath)\MonoGame.Framework.dll" Private="False" />
18+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
1919
<Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
2020
<Reference Include="xTile" HintPath="$(GamePath)\xTile.dll" Private="False" />
2121
</ItemGroup>

‎src/SMAPI.Mods.SaveBackup/SMAPI.Mods.SaveBackup.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</ItemGroup>
1414

1515
<ItemGroup>
16-
<Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
16+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
1717
</ItemGroup>
1818

1919
<ItemGroup>

‎src/SMAPI.Tests/SMAPI.Tests.csproj‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,7 @@
2323
</ItemGroup>
2424

2525
<ItemGroup>
26-
<Reference Include="$(GameExecutableName)">
27-
<HintPath>$(GamePath)\$(GameExecutableName).dll</HintPath>
28-
<Private>True</Private>
29-
</Reference>
26+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="True" />
3027
</ItemGroup>
3128

3229
<ItemGroup>

‎src/SMAPI/SMAPI.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
<ItemGroup>
3131
<Reference Include="..\..\build\0Harmony.dll" Private="True" />
32-
<Reference Include="$(GameExecutableName)" HintPath="$(GamePath)\$(GameExecutableName).dll" Private="False" />
32+
<Reference Include="Stardew Valley" HintPath="$(GamePath)\Stardew Valley.dll" Private="False" />
3333
<Reference Include="StardewValley.GameData" HintPath="$(GamePath)\StardewValley.GameData.dll" Private="False" />
3434
<Reference Include="GalaxyCSharp" HintPath="$(GamePath)\GalaxyCSharp.dll" Private="False" />
3535
<Reference Include="Lidgren.Network" HintPath="$(GamePath)\Lidgren.Network.dll" Private="False" />

0 commit comments

Comments
 (0)