add $(GameExecutableName) to mod build package

This commit is contained in:
Jesse Plamondon-Willard 2019-06-18 23:29:05 -04:00
parent b3e4162f7c
commit 6a951d29ae
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
3 changed files with 26 additions and 12 deletions

View File

@ -38,4 +38,10 @@
</PropertyGroup> </PropertyGroup>
</When> </When>
</Choose> </Choose>
<!-- set game metadata -->
<PropertyGroup>
<GameExecutableName>Stardew Valley</GameExecutableName>
<GameExecutableName Condition="$(OS) != 'Windows_NT'">StardewValley</GameExecutableName>
</PropertyGroup>
</Project> </Project>

View File

@ -1,4 +1,4 @@
The **mod build package** is an open-source NuGet package which automates the MSBuild configuration The **mod build package** is an open-source NuGet package which automates the MSBuild configuration
for SMAPI mods and related tools. The package is fully compatible with Linux, Mac, and Windows. for SMAPI mods and related tools. The package is fully compatible with Linux, Mac, and Windows.
## Contents ## Contents
@ -30,8 +30,14 @@ works by editing your mod's `.csproj` file, and adding the given properties betw
### Detect game path ### Detect game path
The package finds your game folder by scanning the default install paths and Windows registry. It The package finds your game folder by scanning the default install paths and Windows registry. It
adds a `$(GamePath)` variable with the detected path for use in `.csproj` file (e.g. to load a adds two MSBuild properties for use in your `.csproj` file if needed:
custom game DLL). If this doesn't work automatically, see [_set the game path_](#set-the-game-path).
property | description
-------- | -----------
`$(GamePath)` | The absolute path to the detected game folder.
`$(GameExecutableName)` | The game's executable name for the current OS (`Stardew Valley` on Windows, or `StardewValley` on Linux/Mac).
If you get a build error saying it can't find your game, see [_set the game path_](#set-the-game-path).
### Add assembly references ### Add assembly references
The package adds assembly references to SMAPI, Stardew Valley, xTile, and MonoGame (Linux/Mac) or XNA The package adds assembly references to SMAPI, Stardew Valley, xTile, and MonoGame (Linux/Mac) or XNA
@ -256,12 +262,13 @@ If you need to copy the referenced DLLs into your build output, add this too:
## Release notes ## Release notes
### Upcoming release ### Upcoming release
* Updated for SMAPI 3.0 and Stardew Valley 1.4. * Updated for SMAPI 3.0 and Stardew Valley 1.4.
* If the project contains an `assets` folder, its contents are now included in the mod automatically. * Added automatic support for `assets` folders.
* For projects using the new `.csproj` format: * Added `$(GameExecutableName)` MSBuild variable.
* Added support for projects using the simplified `.csproj` format:
* platform target is now set to x86 automatically to avoid mismatching platform target warnings; * platform target is now set to x86 automatically to avoid mismatching platform target warnings;
* added GAC to assembly search paths to fix references to XNA Framework. * added GAC to assembly search paths to fix references to XNA Framework.
* Builds now include `.pdb` files by default, to enable line numbers in error stack traces. * Added option to disable game debugging config.
* You can now optionally disable game debugging config. * Added `.pdb` files to builds by default (to enable line numbers in error stack traces).
* Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly. * Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly.
* Fixed `<IgnoreModFilePatterns>` not working for `i18n` files. * Fixed `<IgnoreModFilePatterns>` not working for `i18n` files.
* Dropped support for older versions of SMAPI and Visual Studio. * Dropped support for older versions of SMAPI and Visual Studio.

View File

@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd"> <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata> <metadata>
<id>Pathoschild.Stardew.ModBuildConfig</id> <id>Pathoschild.Stardew.ModBuildConfig</id>
<version>3.0.0-beta.3</version> <version>3.0.0-beta.4</version>
<title>Build package for SMAPI mods</title> <title>Build package for SMAPI mods</title>
<authors>Pathoschild</authors> <authors>Pathoschild</authors>
<owners>Pathoschild</owners> <owners>Pathoschild</owners>
@ -15,12 +15,13 @@
<releaseNotes> <releaseNotes>
3.0.0: 3.0.0:
- Updated for SMAPI 3.0 and Stardew Valley 1.4. - Updated for SMAPI 3.0 and Stardew Valley 1.4.
- If the project contains an `assets` folder, its contents are now included in the mod automatically. - Added automatic support for `assets` folders.
- For projects using the new `.csproj` format: - Added `$(GameExecutableName)` MSBuild variable.
- Added support for projects using the simplified `.csproj` format:
- platform target is now set to x86 automatically to avoid mismatching platform target warnings; - platform target is now set to x86 automatically to avoid mismatching platform target warnings;
- added GAC to assembly search paths to fix references to XNA Framework. - added GAC to assembly search paths to fix references to XNA Framework.
- Builds now include `.pdb` files by default, to enable line numbers in error stack traces. - Added option to disable game debugging config.
- You can now optionally disable game debugging config. - Added `.pdb` files to builds by default (to enable line numbers in error stack traces).
- Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly. - Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly.
- Fixed `&lt;IgnoreModFilePatterns&gt;` not working for `i18n` files. - Fixed `&lt;IgnoreModFilePatterns&gt;` not working for `i18n` files.
- Dropped support for older versions of SMAPI and Visual Studio. - Dropped support for older versions of SMAPI and Visual Studio.