Pathoschild.Stardew.ModBuildConfig 2.0.3-alpha20180307

The mod build package is an open-source NuGet package which automates the MSBuild configuration for SMAPI mods.

The package...

• lets your code compile on any computer (Linux/Mac/Windows) without changing assembly references or game path.
• packages the mod into the game's Mods folder when you rebuild the code (configurable).
• configures Visual Studio so you can debug into the mod code when the game is running (Windows only).
• creates a release .zip in your bin folder you can upload to release the mod.

Install

When creating a new mod:

1. Create an empty library project.
2. Reference the Pathoschild.Stardew.ModBuildConfig NuGet package.
3. Write your code.
4. Compile on any platform.

When migrating an existing mod:

1. Remove any project references to Microsoft.Xna.*, MonoGame, NetCode, Stardew Valley, StardewModdingAPI, and xTile.
2. Reference the Pathoschild.Stardew.ModBuildConfig NuGet package.
3. Compile on any platform.

Configure

Deploy files into the Mods folder

By default, your mod will be copied into the game's Mods folder (with a subfolder matching your project name) when you rebuild the code. The package will automatically include your manifest.json, any i18n files, and the build output.

To add custom files to the mod folder, just add them to the build output. (If your project references another mod, make sure the reference is not marked 'copy local'.)

You can change the mod's folder name by adding this above the first </PropertyGroup> in your .csproj:

<ModFolderName>YourModName</ModFolderName>

If you don't want to deploy the mod automatically, you can add this:

<EnableModDeploy>False</EnableModDeploy>

Create release zip

By default, a zip file will be created in the build output when you rebuild the code. This zip file contains all the files needed to share your mod in the recommended format for uploading to Nexus Mods or other sites.

You can change the zipped folder name (and zip name) by adding this above the first </PropertyGroup> in your .csproj:

<ModFolderName>YourModName</ModFolderName>

You can change the folder path where the zip is created like this:

<ModZipPath>$(SolutionDir)\_releases</ModZipPath>

Finally, you can disable the zip creation with this:

<EnableModZip>False</EnableModZip>

Or only create it in release builds with this:

<EnableModZip Condition="$(Configuration) != 'Release'">False</EnableModZip>

Game path

The package usually detects where your game is installed automatically. If it can't find your game or you have multiple installs, you can specify the path yourself. There's two ways to do that:

• Option 1: global game path (recommended).
  This will apply to every project that uses the package.

  1. Get the full folder path containing the Stardew Valley executable.

  2. Create this file:

     • Linux/Mac: ~/stardewvalley.targets
     • Windows: %USERPROFILE%\stardewvalley.targets

  3. Save the file with this content:

     <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
        <PropertyGroup>
          <GamePath>PATH_HERE</GamePath>
        </PropertyGroup>
     </Project>
     

  4. Replace PATH_HERE with your game path.

• Option 2: path in the project file.
  You'll need to do this for each project that uses the package.

  1. Get the folder path containing the Stardew Valley .exe file.

  2. Add this to your .csproj file under the <Project line:

     <PropertyGroup>
       <GamePath>PATH_HERE</GamePath>
     </PropertyGroup>
     

  3. Replace PATH_HERE with your custom game install path.

The configuration will check your custom path first, then fall back to the default paths (so it'll still compile on a different computer).

Troubleshoot

"Failed to find the game install path"

That error means the package couldn't find your game. You can specify the game path yourself; see Game path above.