diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index b091c2c0..f02981b9 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -71,6 +71,11 @@ Finally, you can disable the zip creation with this:
False
```
+Or only create it in release builds with this:
+```xml
+False
+```
+
### 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:
@@ -118,14 +123,15 @@ 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 need to specify the game path yourself;
-see _[Game path](#game-path)_ above.
+That error means the package couldn't find your game. You can specify the game path yourself; see
+_[Game path](#game-path)_ above.
## Release notes
### 2.0
-* Mods are now copied into the `Mods` folder automatically (configurable).
-* The release zip is now created automatically in your build output folder (configurable).
+* Added: mods are now copied into the `Mods` folder automatically (configurable).
+* Added: release zips are now created automatically in your build output folder (configurable).
* Added mod's version to release zip filename.
+* Improved errors to simplify troubleshooting.
* Fixed release zip not having a mod folder.
* Fixed release zip failing if mod name contains characters that aren't valid in a filename.
diff --git a/src/SMAPI.ModBuildConfig/DeployModTask.cs b/src/SMAPI.ModBuildConfig/DeployModTask.cs
index 2018ab06..a693fe32 100644
--- a/src/SMAPI.ModBuildConfig/DeployModTask.cs
+++ b/src/SMAPI.ModBuildConfig/DeployModTask.cs
@@ -2,11 +2,9 @@ using System;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
-using System.Linq;
-using System.Web.Script.Serialization;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
-using StardewModdingAPI.Common;
+using StardewModdingAPI.ModBuildConfig.Framework;
namespace StardewModdingAPI.ModBuildConfig
{
@@ -16,25 +14,53 @@ namespace StardewModdingAPI.ModBuildConfig
/*********
** Properties
*********/
- /// The name of the manifest file.
- private readonly string ManifestFileName = "manifest.json";
+ /// The MSBuild platforms recognised by the build configuration.
+ private readonly HashSet ValidPlatforms = new HashSet(new[] { "OSX", "Unix", "Windows_NT" }, StringComparer.InvariantCultureIgnoreCase);
+
+ /// The name of the game's main executable file.
+ private string GameExeName => this.Platform == "Windows_NT"
+ ? "Stardew Valley.exe"
+ : "StardewValley.exe";
+
+ /// The name of SMAPI's main executable file.
+ private readonly string SmapiExeName = "StardewModdingAPI.exe";
/*********
** Accessors
*********/
- /// The mod files to pack.
+ /// The name of the mod folder.
[Required]
- public ITaskItem[] Files { get; set; }
-
- /// The name of the mod.
- [Required]
- public string ModName { get; set; }
+ public string ModFolderName { get; set; }
/// The absolute or relative path to the folder which should contain the generated zip file.
[Required]
public string ModZipPath { get; set; }
+ /// The folder containing the project files.
+ [Required]
+ public string ProjectDir { get; set; }
+
+ /// The folder containing the build output.
+ [Required]
+ public string TargetDir { get; set; }
+
+ /// The folder containing the game files.
+ [Required]
+ public string GameDir { get; set; }
+
+ /// The MSBuild OS value.
+ [Required]
+ public string Platform { get; set; }
+
+ /// Whether to enable copying the mod files into the game's Mods folder.
+ [Required]
+ public bool EnableModDeploy { get; set; }
+
+ /// Whether to enable the release zip.
+ [Required]
+ public bool EnableModZip { get; set; }
+
/*********
** Public methods
@@ -43,33 +69,80 @@ namespace StardewModdingAPI.ModBuildConfig
/// true if the task successfully executed; otherwise, false.
public override bool Execute()
{
+ if (!this.EnableModDeploy && !this.EnableModZip)
+ return true; // nothing to do
+
try
{
- string modVersion = this.GetManifestVersion();
- this.CreateReleaseZip(this.Files, this.ModName, modVersion, this.ModZipPath);
+ // validate context
+ if (!this.ValidPlatforms.Contains(this.Platform))
+ throw new UserErrorException($"The mod build package doesn't recognise OS type '{this.Platform}'.");
+ if (!Directory.Exists(this.GameDir))
+ throw new UserErrorException("The mod build package can't find your game path. See https://github.com/Pathoschild/SMAPI/blob/develop/docs/mod-build-config.md for help specifying it.");
+ if (!File.Exists(Path.Combine(this.GameDir, this.GameExeName)))
+ throw new UserErrorException($"The mod build package found a game folder at {this.GameDir}, but it doesn't contain the {this.GameExeName} file. If this folder is invalid, delete it and the package will autodetect another game install path.");
+ if (!File.Exists(Path.Combine(this.GameDir, this.SmapiExeName)))
+ throw new UserErrorException($"The mod build package found a game folder at {this.GameDir}, but it doesn't contain SMAPI. You need to install SMAPI before building the mod.");
+
+ // get mod info
+ ModFileManager package = new ModFileManager(this.ProjectDir, this.TargetDir);
+
+ // deploy mod files
+ if (this.EnableModDeploy)
+ {
+ string outputPath = Path.Combine(this.GameDir, "Mods", this.EscapeInvalidFilenameCharacters(this.ModFolderName));
+ this.Log.LogMessage(MessageImportance.High, $"The mod build package is copying the mod files to {outputPath}...");
+ this.CreateModFolder(package.GetFiles(), outputPath);
+ }
+
+ // create release zip
+ if (this.EnableModZip)
+ {
+ this.Log.LogMessage(MessageImportance.High, $"The mod build package is generating a release zip at {this.ModZipPath} for {this.ModFolderName}...");
+ this.CreateReleaseZip(package.GetFiles(), this.ModFolderName, package.GetManifestVersion(), this.ModZipPath);
+ }
return true;
}
- catch (Exception ex)
+ catch (UserErrorException ex)
{
this.Log.LogErrorFromException(ex);
return false;
}
+ catch (Exception ex)
+ {
+ this.Log.LogError($"The mod build package failed trying to deploy the mod.\n{ex}");
+ return false;
+ }
}
/*********
** Private methods
*********/
+ /// Copy the mod files into the game's mod folder.
+ /// The files to include.
+ /// The folder path to create with the mod files.
+ private void CreateModFolder(IDictionary files, string modFolderPath)
+ {
+ Directory.CreateDirectory(modFolderPath);
+ foreach (var entry in files)
+ {
+ string fromPath = entry.Value.FullName;
+ string toPath = Path.Combine(modFolderPath, entry.Key);
+ File.Copy(fromPath, toPath, overwrite: true);
+ }
+ }
+
/// Create a release zip in the recommended format for uploading to mod sites.
/// The files to include.
/// The name of the mod.
/// The mod version string.
/// The absolute or relative path to the folder which should contain the generated zip file.
- private void CreateReleaseZip(ITaskItem[] files, string modName, string modVersion, string outputFolderPath)
+ private void CreateReleaseZip(IDictionary files, string modName, string modVersion, string outputFolderPath)
{
// get names
- string zipName = this.EscapeInvalidFilenameCharacters($"{modName}-{modVersion}.zip");
+ string zipName = this.EscapeInvalidFilenameCharacters($"{modName} {modVersion}.zip");
string folderName = this.EscapeInvalidFilenameCharacters(modName);
string zipPath = Path.Combine(outputFolderPath, zipName);
@@ -78,84 +151,25 @@ namespace StardewModdingAPI.ModBuildConfig
using (Stream zipStream = new FileStream(zipPath, FileMode.Create, FileAccess.Write))
using (ZipArchive archive = new ZipArchive(zipStream, ZipArchiveMode.Create))
{
- foreach (ITaskItem file in files)
+ foreach (var fileEntry in files)
{
+ string relativePath = fileEntry.Key;
+ FileInfo file = fileEntry.Value;
+
// get file info
- string filePath = file.ItemSpec;
- string entryName = folderName + '/' + file.GetMetadata("RecursiveDir") + file.GetMetadata("Filename") + file.GetMetadata("Extension");
+ string filePath = file.FullName;
+ string entryName = folderName + '/' + relativePath.Replace(Path.DirectorySeparatorChar, '/');
if (new FileInfo(filePath).Directory.Name.Equals("i18n", StringComparison.InvariantCultureIgnoreCase))
entryName = Path.Combine("i18n", entryName);
// add to zip
using (Stream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read))
using (Stream fileStreamInZip = archive.CreateEntry(entryName).Open())
- {
fileStream.CopyTo(fileStreamInZip);
- }
}
}
}
- /// Get a semantic version from the mod manifest (if available).
- /// The manifest file wasn't found or is invalid.
- private string GetManifestVersion()
- {
- // find manifest file
- ITaskItem file = this.Files.FirstOrDefault(p => this.ManifestFileName.Equals(Path.GetFileName(p.ItemSpec), StringComparison.InvariantCultureIgnoreCase));
- if (file == null)
- throw new InvalidOperationException($"The mod must include a {this.ManifestFileName} file.");
-
- // read content
- string json = File.ReadAllText(file.ItemSpec);
- if (string.IsNullOrWhiteSpace(json))
- throw new InvalidOperationException($"The mod's {this.ManifestFileName} file must not be empty.");
-
- // parse JSON
- IDictionary data;
- try
- {
- data = this.Parse(json);
- }
- catch (Exception ex)
- {
- throw new InvalidOperationException($"The mod's {this.ManifestFileName} couldn't be parsed. It doesn't seem to be valid JSON.", ex);
- }
-
- // get version field
- object versionObj = data.ContainsKey("Version") ? data["Version"] : null;
- if (versionObj == null)
- throw new InvalidOperationException($"The mod's {this.ManifestFileName} must have a version field.");
-
- // get version string
- if (versionObj is IDictionary versionFields) // SMAPI 1.x
- {
- int major = versionFields.ContainsKey("MajorVersion") ? (int)versionFields["MajorVersion"] : 0;
- int minor = versionFields.ContainsKey("MinorVersion") ? (int)versionFields["MinorVersion"] : 0;
- int patch = versionFields.ContainsKey("PatchVersion") ? (int)versionFields["PatchVersion"] : 0;
- string tag = versionFields.ContainsKey("Build") ? (string)versionFields["Build"] : null;
- return new SemanticVersionImpl(major, minor, patch, tag).ToString();
- }
- return new SemanticVersionImpl(versionObj.ToString()).ToString(); // SMAPI 2.0+
- }
-
- /// Get a case-insensitive dictionary matching the given JSON.
- /// The JSON to parse.
- private IDictionary Parse(string json)
- {
- IDictionary MakeCaseInsensitive(IDictionary dict)
- {
- foreach (var field in dict.ToArray())
- {
- if (field.Value is IDictionary value)
- dict[field.Key] = MakeCaseInsensitive(value);
- }
- return new Dictionary(dict, StringComparer.InvariantCultureIgnoreCase);
- }
-
- IDictionary data = (IDictionary)new JavaScriptSerializer().DeserializeObject(json);
- return MakeCaseInsensitive(data);
- }
-
/// Get a copy of a filename with all invalid filename characters substituted.
/// The filename.
private string EscapeInvalidFilenameCharacters(string name)
diff --git a/src/SMAPI.ModBuildConfig/Framework/ModFileManager.cs b/src/SMAPI.ModBuildConfig/Framework/ModFileManager.cs
new file mode 100644
index 00000000..9d9054f1
--- /dev/null
+++ b/src/SMAPI.ModBuildConfig/Framework/ModFileManager.cs
@@ -0,0 +1,162 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Web.Script.Serialization;
+using StardewModdingAPI.Common;
+
+namespace StardewModdingAPI.ModBuildConfig.Framework
+{
+ /// Manages the files that are part of a mod package.
+ internal class ModFileManager
+ {
+ /*********
+ ** Properties
+ *********/
+ /// The name of the manifest file.
+ private readonly string ManifestFileName = "manifest.json";
+
+ /// The files that are part of the package.
+ private readonly IDictionary Files;
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// Construct an instance.
+ /// The folder containing the project files.
+ /// The folder containing the build output.
+ /// The mod package isn't valid.
+ public ModFileManager(string projectDir, string targetDir)
+ {
+ this.Files = new Dictionary(StringComparer.InvariantCultureIgnoreCase);
+
+ // validate paths
+ if (!Directory.Exists(projectDir))
+ throw new UserErrorException("Could not create mod package because the project folder wasn't found.");
+ if (!Directory.Exists(targetDir))
+ throw new UserErrorException("Could not create mod package because no build output was found.");
+
+ // project manifest
+ bool hasProjectManifest = false;
+ {
+ FileInfo manifest = new FileInfo(Path.Combine(projectDir, "manifest.json"));
+ if (manifest.Exists)
+ {
+ this.Files[this.ManifestFileName] = manifest;
+ hasProjectManifest = true;
+ }
+ }
+
+ // project i18n files
+ bool hasProjectTranslations = false;
+ DirectoryInfo translationsFolder = new DirectoryInfo(Path.Combine(projectDir, "i18n"));
+ if (translationsFolder.Exists)
+ {
+ foreach (FileInfo file in translationsFolder.EnumerateFiles())
+ this.Files[Path.Combine("i18n", file.Name)] = file;
+ hasProjectTranslations = true;
+ }
+
+ // build output
+ DirectoryInfo buildFolder = new DirectoryInfo(targetDir);
+ foreach (FileInfo file in buildFolder.EnumerateFiles("*", SearchOption.AllDirectories))
+ {
+ // get relative paths
+ string relativePath = file.FullName.Replace(buildFolder.FullName, "");
+ string relativeDirPath = file.Directory.FullName.Replace(buildFolder.FullName, "");
+
+ // prefer project manifest/i18n files
+ if (hasProjectManifest && relativePath.Equals(this.ManifestFileName, StringComparison.InvariantCultureIgnoreCase))
+ continue;
+ if (hasProjectTranslations && relativeDirPath.Equals("i18n", StringComparison.InvariantCultureIgnoreCase))
+ continue;
+
+ // ignore release zips
+ if (file.Extension.Equals("zip", StringComparison.InvariantCultureIgnoreCase))
+ continue;
+
+ // add file
+ this.Files[relativePath] = file;
+ }
+
+ // check for missing manifest
+ if (!this.Files.ContainsKey(this.ManifestFileName))
+ throw new UserErrorException($"Could not create mod package because no {this.ManifestFileName} was found in the project or build output.");
+
+ // check for missing DLL
+ // ReSharper disable once SimplifyLinqExpression
+ if (!this.Files.Any(p => !p.Key.EndsWith(".dll")))
+ throw new UserErrorException("Could not create mod package because no .dll file was found in the project or build output.");
+ }
+
+ /// Get the files in the mod package.
+ public IDictionary GetFiles()
+ {
+ return new Dictionary(this.Files, StringComparer.InvariantCultureIgnoreCase);
+ }
+
+ /// Get a semantic version from the mod manifest.
+ /// The manifest is missing or invalid.
+ public string GetManifestVersion()
+ {
+ // get manifest file
+ if (!this.Files.TryGetValue(this.ManifestFileName, out FileInfo manifestFile))
+ throw new InvalidOperationException($"The mod does not have a {this.ManifestFileName} file."); // shouldn't happen since we validate in constructor
+
+ // read content
+ string json = File.ReadAllText(manifestFile.FullName);
+ if (string.IsNullOrWhiteSpace(json))
+ throw new UserErrorException("The mod's manifest must not be empty.");
+
+ // parse JSON
+ IDictionary data;
+ try
+ {
+ data = this.Parse(json);
+ }
+ catch (Exception ex)
+ {
+ throw new UserErrorException($"The mod's manifest couldn't be parsed. It doesn't seem to be valid JSON.\n{ex}");
+ }
+
+ // get version field
+ object versionObj = data.ContainsKey("Version") ? data["Version"] : null;
+ if (versionObj == null)
+ throw new UserErrorException("The mod's manifest must have a version field.");
+
+ // get version string
+ if (versionObj is IDictionary versionFields) // SMAPI 1.x
+ {
+ int major = versionFields.ContainsKey("MajorVersion") ? (int)versionFields["MajorVersion"] : 0;
+ int minor = versionFields.ContainsKey("MinorVersion") ? (int)versionFields["MinorVersion"] : 0;
+ int patch = versionFields.ContainsKey("PatchVersion") ? (int)versionFields["PatchVersion"] : 0;
+ string tag = versionFields.ContainsKey("Build") ? (string)versionFields["Build"] : null;
+ return new SemanticVersionImpl(major, minor, patch, tag).ToString();
+ }
+ return new SemanticVersionImpl(versionObj.ToString()).ToString(); // SMAPI 2.0+
+ }
+
+
+ /*********
+ ** Private methods
+ *********/
+ /// Get a case-insensitive dictionary matching the given JSON.
+ /// The JSON to parse.
+ private IDictionary Parse(string json)
+ {
+ IDictionary MakeCaseInsensitive(IDictionary dict)
+ {
+ foreach (var field in dict.ToArray())
+ {
+ if (field.Value is IDictionary value)
+ dict[field.Key] = MakeCaseInsensitive(value);
+ }
+ return new Dictionary(dict, StringComparer.InvariantCultureIgnoreCase);
+ }
+
+ IDictionary data = (IDictionary)new JavaScriptSerializer().DeserializeObject(json);
+ return MakeCaseInsensitive(data);
+ }
+ }
+}
diff --git a/src/SMAPI.ModBuildConfig/Framework/UserErrorException.cs b/src/SMAPI.ModBuildConfig/Framework/UserErrorException.cs
new file mode 100644
index 00000000..64e31c29
--- /dev/null
+++ b/src/SMAPI.ModBuildConfig/Framework/UserErrorException.cs
@@ -0,0 +1,16 @@
+using System;
+
+namespace StardewModdingAPI.ModBuildConfig.Framework
+{
+ /// A user error whose message can be displayed to the user.
+ internal class UserErrorException : Exception
+ {
+ /*********
+ ** Public methods
+ *********/
+ /// Construct an instance.
+ /// The error message.
+ public UserErrorException(string message)
+ : base(message) { }
+ }
+}
diff --git a/src/SMAPI.ModBuildConfig/StardewModdingAPI.ModBuildConfig.csproj b/src/SMAPI.ModBuildConfig/StardewModdingAPI.ModBuildConfig.csproj
index f943bc97..2a445f72 100644
--- a/src/SMAPI.ModBuildConfig/StardewModdingAPI.ModBuildConfig.csproj
+++ b/src/SMAPI.ModBuildConfig/StardewModdingAPI.ModBuildConfig.csproj
@@ -39,12 +39,15 @@
+
+
Designer
+ PreserveNewest
Designer
diff --git a/src/SMAPI.ModBuildConfig/build/smapi.targets b/src/SMAPI.ModBuildConfig/build/smapi.targets
index 46e8428d..0010d8ff 100644
--- a/src/SMAPI.ModBuildConfig/build/smapi.targets
+++ b/src/SMAPI.ModBuildConfig/build/smapi.targets
@@ -7,15 +7,24 @@
-
+
-
+
+
+
+ $(DeployModFolderName)
+ $(DeployModZipTo)
+
+
+ $(MSBuildProjectName)
+ $(TargetDir)
+ True
+ True
+
+
+
@@ -106,52 +115,21 @@
-
-
-
-
+
+
-
-
-
-
-
+ EnableModDeploy="$(EnableModDeploy)"
+ EnableModZip="$(EnableModZip)"
-
-
-
-
- $(GamePath)\Mods\$(DeployModFolderName)
-
-
-
-
+ ProjectDir="$(ProjectDir)"
+ TargetDir="$(TargetDir)"
+ GameDir="$(GamePath)"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ Platform="$(OS)"
+ />