[
{
"path": ".editorconfig",
"content": "# topmost editorconfig\nroot: true\n\n##########\n## General formatting\n## documentation: http://editorconfig.org\n##########\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\ncharset = utf-8\n\n[*.{csproj,nuspec,targets}]\nindent_size = 2\n\n[*.csproj]\ncharset = utf-8-bom\ninsert_final_newline = false\n\n##########\n## C# formatting\n## documentation: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference\n##########\n[*.cs]\n\n#sort 'system' usings first\ndotnet_sort_system_directives_first = true\n\n# use 'this.' qualifier\ndotnet_style_qualification_for_field = true:error\ndotnet_style_qualification_for_property = true:error\ndotnet_style_qualification_for_method = true:error\ndotnet_style_qualification_for_event = true:error\n\n# use language keywords (like int) instead of type (like Int32)\ndotnet_style_predefined_type_for_locals_parameters_members = true:error\ndotnet_style_predefined_type_for_member_access = true:error\n\n# don't use 'var' for language keywords\ncsharp_style_var_for_built_in_types = false:error\n\n# suggest modern C# features where simpler\ndotnet_style_object_initializer = true:suggestion\ndotnet_style_collection_initializer = true:suggestion\ndotnet_style_coalesce_expression = true:suggestion\ndotnet_style_null_propagation = true:suggestion\ndotnet_style_explicit_tuple_names = true:suggestion\ncsharp_style_pattern_matching_over_is_with_cast_check = true:suggestion\ncsharp_style_pattern_matching_over_as_with_null_check = true:suggestion\ncsharp_style_conditional_delegate_call = true:suggestion\ncsharp_prefer_simple_default_expression = true:suggestion\n\n# prefer method block bodies\ncsharp_style_expression_bodied_methods = false:suggestion\ncsharp_style_expression_bodied_constructors = false:suggestion\n\n# prefer property expression bodies\ncsharp_style_expression_bodied_properties = true:suggestion\ncsharp_style_expression_bodied_indexers = true:suggestion\ncsharp_style_expression_bodied_accessors = true:suggestion\n\n# prefer inline out variables\ncsharp_style_inlined_variable_declaration = true:warning\n\n# avoid superfluous braces\ncsharp_prefer_braces = false:suggestion\n"
},
{
"path": ".gitattributes",
"content": "# always normalise line endings\n* text=auto\n"
},
{
"path": ".gitignore",
"content": "# user-specific files\n*.suo\n*.user\n*.userosscache\n*.sln.docstates\n\n# build results\n[Dd]ebug/\n[Rr]elease/\n[Bb]in/\n[Oo]bj/\n\n# Visual Studio cache/options\n.vs/\n\n# ReSharper\n_ReSharper*/\n*.[Rr]e[Ss]harper\n*.DotSettings.user\n\n# Rider\n.idea/\n\n# NuGet packages\n*.nupkg\n**/packages/*\n*.nuget.props\n*.nuget.targets\n.DS_Store\n"
},
{
"path": "LICENSE",
"content": "The MIT License (MIT)\n\nCopyright 2019 Pathoschild\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "**StardewXnbHack** is a one-way XNB unpacker for Stardew Valley. It supports every Stardew Valley\nasset type, is very easy to update for game changes, and is quick at unpacking many files at once.\n\n\n\n## Usage\nTo install it:\n\n1. Install [Stardew Valley](https://www.stardewvalley.net/) and [SMAPI](https://smapi.io/).\n2. From the [releases page](https://github.com/Pathoschild/StardewXnbHack/releases), download the\n `StardewXnbHack *.zip` file for your operating system under 'assets'.\n3. Unzip it into [your Stardew Valley folder](https://stardewvalleywiki.com/Modding:Game_folder),\n so `StardewXnbHack.exe` (Windows) or `StardewXnbHack` (Linux/macOS) is in the same folder as\n `Stardew Valley.dll`.\n\nTo unpack the entire `Content` folder into `Content (unpacked)`, just double-click on\n`StardewXnbHack.exe` (Windows) or `StardewXnbHack` (Linux/macOS).\n\n## FAQs\n### How does this compare to other XNB unpackers?\nStardewXnbHack reads files through a temporary game instance, unlike other unpackers which read\nthem directly. That lets it support custom Stardew Valley formats, but it can't repack files (which\nis [rarely needed anyway](https://stardewvalleywiki.com/Modding:Content_Patcher)) or support other\ngames.\n\nThe main differences at a glance:\n\n | StardewXnbHack | [xnbcli](https://github.com/LeonBlade/xnbcli/) | [XNBExtract](https://community.playstarbound.com/threads/110976)\n--------------------- | ---------------- | ------ | -----------\nSupported asset types | ✓ images ✓ maps ✓ dictionary data ✓ font texture ✓ font XML data ✓ structured data | ✓ images ✓ maps ✓ dictionary data ✓ font textures ✓ font XML data ❑ structured data | ✓ images ✓ maps ✓ dictionary data ✓ font textures ❑ font XML data ❑ structured data\nExport formats | ✓ `.png` for images ✓ `.tmx` for maps ✓ `.json` for data ([CP](https://stardewvalleywiki.com/Modding:Content_Patcher)-compatible) | ✓ `.png` for images ✓ `.tbin` for maps¹ ❑ `.json` for data (custom format) | ✓ `.png` for images ✓ `.tbin` for maps¹ ❑ `.yaml` for data\nSupported platforms | ✓ Windows ✓ Linux ✓ Mac | ✓ Windows ✓ Linux ✓ Mac | ✓ Windows ❑ Linux ❑ Mac\nSupported operations | ✓ unpack ❑ pack | ✓ unpack ✓ pack (uncompressed) | ✓ unpack ✓ pack\nMaintainable | ✓ easy to update | ❑ complex | ❑ complex, closed-source\nSample unpack time (full `Content` folder) | ≈0m 43s | ≈6m 5s | ≈2m 20s\nLicense | MIT | GPL | n/a\n\n¹ `.tmx` is the [preferred map format](https://stardewvalleywiki.com/Modding:Maps#Map_formats), but you can open the `.tbin` file in Tiled and export it as `.tmx`.\n\n### When I run StardewXnbHack, nothing happens or it quickly exits?\nThat means it crashed for some reason.\n\nFirst, make sure you have the latest versions of SMAPI and Stardew Valley.\n\nIf it still happens, here's how to see what the error is:\n\n
\n\n1. Find [your game folder](https://stardewvalleywiki.com/Modding:Game_folder).\n2. [Open a terminal in the game folder](https://www.groovypost.com/howto/open-command-window-terminal-window-specific-folder-windows-mac-linux/).\n3. Type this command:\n * **Windows:** `StardewXnbHack.exe` (for Command Prompt) or `./StardewXnbHack.exe` (for PowerShell or Windows Terminal)\n * **Linux or macOS:** `./StardewXnbHack`\n4. Press enter to run the command.\n\nThat should run StardewXnbHack in the same terminal, and the window will stay open if it crashes.\n
\n\nYou can ask for help in [#making-mods on the Stardew Valley Discord](https://stardewvalleywiki.com/Modding:Community#Discord).\nIf you're sure it's a StardewXnbHack bug (and not a usage error), you can report it on the [issues\npage](https://github.com/Pathoschild/StardewXnbHack/issues).\n\n### Can I simplify the data files?\nBy default, unpacked data files include _all_ of the fields. This can be very noisy, and doesn't\nreally match how the data assets are formatted in the original code.\n\nYou can omit the default fields instead:\n\n1. Open a terminal in [your game folder](https://stardewvalleywiki.com/Modding:Game_folder).\n2. Run `StardewXnbHack.exe --clean` to omit the default fields.\n\nThis is still experimental, but it may become the default behavior in future versions.\n\n\n## For StardewXnbHack developers\nThis section explains how to edit or compile StardewXnbHack from the source code. Most users should\n[use the release version](#usage) instead.\n\n### Compile from source\n1. Install [Stardew Valley](https://www.stardewvalley.net/) and [SMAPI](https://smapi.io/).\n2. Open the `.sln` solution file in [Visual Studio](https://visualstudio.microsoft.com/vs/).\n3. Click _Build > Build Solution_. (If it doesn't find the Stardew Valley folder automatically, see\n [_custom game path_ in the mod build package readme](https://smapi.io/package/custom-game-path).)\n\n### Debug a local build\nJust launch the project via _Debug > Start Debugging_. It will run from your `bin` folder, but\nshould auto-detect your game folder and unpack its `Content` folder.\n\n### Prepare a compiled release\nTo prepare a crossplatform SMAPI release:\n\n1. Update the [semantic version](https://semver.org) in `StardewXnbHack.csproj`.\n2. Run the `build-scripts/prepare-release-packages.sh` on Linux or macOS. \n _See the [equivalent documentation for SMAPI](https://github.com/Pathoschild/SMAPI/blob/develop/docs/technical/smapi.md#preparing-a-release)\n for the first-time setup (including using WSL on Windows)._\n3. Release the zip files created in the root `bin` folder.\n\n## See also\n* [Release notes](release-notes.md)\n"
},
{
"path": "StardewXnbHack/Framework/ConsoleProgressBar.cs",
"content": "using System;\n\nnamespace StardewXnbHack.Framework;\n\n/// Manages a progress bar written to the console.\ninternal class ConsoleProgressBar\n{\n /*********\n ** Fields\n *********/\n /// The total number of steps to perform.\n private readonly int TotalSteps;\n\n /// The current step being performed.\n private int CurrentStep;\n\n /// The last line to which the progress bar was output, if any.\n private int OutputLine = -1;\n\n\n /*********\n ** Public methods\n *********/\n /// Construct an instance.\n /// The total number of steps to perform.\n public ConsoleProgressBar(int totalSteps)\n {\n this.TotalSteps = totalSteps;\n }\n\n /// Increment the current step.\n public void Increment()\n {\n this.CurrentStep++;\n }\n\n /// Print a progress bar to the console.\n /// The message to print.\n /// Whether to remove the previously output progress bar.\n public void Print(string message, bool removePrevious = true)\n {\n if (removePrevious)\n this.Erase();\n\n int percentage = (int)((this.CurrentStep / (this.TotalSteps * 1m)) * 100);\n\n Console.ForegroundColor = ConsoleColor.Green;\n Console.WriteLine($\"[{\"\".PadRight(percentage / 10, '#')}{\"\".PadRight(10 - percentage / 10, ' ')} {percentage}%] {message}\");\n Console.ResetColor();\n\n this.OutputLine = Console.CursorTop - 1;\n }\n\n /// Remove the last progress bar written to the console.\n /// Derived from .\n public void Erase()\n {\n if (this.OutputLine == -1)\n return;\n\n bool isLastLine = this.OutputLine == Console.CursorTop - 1;\n int currentLine = isLastLine\n ? this.OutputLine\n : Console.CursorTop;\n\n Console.SetCursorPosition(0, this.OutputLine);\n Console.Write(new string(' ', Console.BufferWidth));\n Console.SetCursorPosition(0, currentLine);\n\n this.OutputLine = -1;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/DefaultConsoleLogger.cs",
"content": "using System;\nusing System.Linq;\nusing StardewXnbHack.ProgressHandling;\n\nnamespace StardewXnbHack.Framework;\n\n/// Report updates to the console while the unpacker is running.\ninternal class DefaultConsoleLogger : IProgressLogger\n{\n /*********\n ** Fields\n *********/\n /// The context info for the current unpack run.\n private readonly IUnpackContext Context;\n\n /// Whether to show a 'press any key to exit' prompt on end.\n private readonly bool ShowPressAnyKeyToExit;\n\n /// The current progress bar written to the console.\n private ConsoleProgressBar ProgressBar;\n\n\n /*********\n ** Public methods\n *********/\n /// Construct an instance.\n /// The context info for the current unpack run.\n /// Whether to show a 'press any key to exit' prompt on end.\n public DefaultConsoleLogger(IUnpackContext context, bool showPressAnyKeyToExit)\n {\n this.Context = context;\n this.ShowPressAnyKeyToExit = showPressAnyKeyToExit;\n }\n\n /// \n public void OnFatalError(string error)\n {\n this.PrintColor(error, ConsoleColor.Red);\n }\n\n /// \n public void OnStepChanged(ProgressStep step, string message)\n {\n this.ProgressBar?.Erase();\n\n if (step == ProgressStep.Done)\n Console.WriteLine();\n\n Console.WriteLine(message);\n }\n\n /// \n public void OnFileUnpacking(string relativePath)\n {\n if (this.ProgressBar == null)\n this.ProgressBar = new ConsoleProgressBar(this.Context.Files.Count());\n\n this.ProgressBar.Increment();\n this.ProgressBar.Print(relativePath);\n }\n\n /// \n public void OnFileUnpackFailed(string relativePath, UnpackFailedReason errorCode, string errorMessage)\n {\n ConsoleColor color = errorCode == UnpackFailedReason.UnsupportedFileType\n ? ConsoleColor.DarkYellow\n : ConsoleColor.Red;\n\n this.ProgressBar.Erase();\n this.PrintColor($\"{relativePath} => {errorMessage}\", color);\n }\n\n /// \n public void OnEnded()\n {\n if (this.ShowPressAnyKeyToExit)\n DefaultConsoleLogger.PressAnyKeyToExit();\n }\n\n /// Show a 'press any key to exit' message and wait for a key press.\n public static void PressAnyKeyToExit()\n {\n Console.WriteLine();\n Console.WriteLine(\"Press any key to exit.\");\n Console.ReadKey();\n }\n\n\n /*********\n ** Private methods\n *********/\n /// Print a message to the console with a foreground color.\n /// The message to print.\n /// The foreground color to use.\n private void PrintColor(string message, ConsoleColor color)\n {\n Console.ForegroundColor = color;\n Console.WriteLine(message);\n Console.ResetColor();\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/PlatformContext.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Linq;\nusing StardewModdingAPI.Toolkit;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework;\n\n/// Provides platform-specific information.\ninternal class PlatformContext\n{\n /*********\n ** Accessors\n *********/\n /// The current platform.\n public Platform Platform { get; } = EnvironmentUtility.DetectPlatform();\n\n\n /*********\n ** Public methods\n *********/\n /// Get whether any of the listed platforms is the current one.\n /// The platforms to match.\n public bool Is(params Platform[] platforms)\n {\n return platforms.Contains(this.Platform);\n }\n\n /// Get the absolute paths to the game and content folders, if found.\n /// The game path specified by the user, if any.\n /// The absolute path to the game folder, if found.\n /// The absolute path to the content folder, if found.\n /// Returns whether both the game and content folders were found.\n public bool TryDetectGamePaths(string specifiedPath, out string gamePath, out string contentPath)\n {\n gamePath = null;\n contentPath = null;\n\n // check possible game paths\n foreach (string candidate in this.GetCandidateGamePaths(specifiedPath))\n {\n // detect paths\n string curGamePath = this.TryGamePath(candidate);\n string curContentPath = this.FindContentPath(curGamePath);\n\n // valid game install found\n if (curGamePath != null && curContentPath != null)\n {\n gamePath = curGamePath;\n contentPath = curContentPath;\n return true;\n }\n\n // if game folder exists without a content folder, track the first found game path (i.e. the highest-priority one)\n gamePath ??= curGamePath;\n }\n\n return false;\n }\n\n\n /*********\n ** Private methods\n *********/\n /// Get the possible game paths.\n /// The game path specified by the user, if any.\n private IEnumerable GetCandidateGamePaths(string specifiedPath = null)\n {\n // specified path\n if (!string.IsNullOrWhiteSpace(specifiedPath))\n yield return specifiedPath;\n\n // current working directory\n yield return AppDomain.CurrentDomain.BaseDirectory;\n\n // detected game path\n string detectedPath = new ModToolkit().GetGameFolders().FirstOrDefault()?.FullName;\n if (detectedPath != null)\n yield return detectedPath;\n }\n\n /// Get the absolute path to the game folder, if it's valid.\n /// The path to check for a game install.\n private string TryGamePath(string path)\n {\n // game path exists\n if (path == null)\n return null;\n DirectoryInfo gameDir = new DirectoryInfo(path);\n if (!gameDir.Exists)\n return null;\n\n // has game files\n bool hasGameDll = File.Exists(Path.Combine(gameDir.FullName, \"Stardew Valley.dll\"));\n if (!hasGameDll)\n return null;\n\n // isn't the build folder when compiled directly\n bool isCompileFolder = File.Exists(Path.Combine(gameDir.FullName, \"StardewXnbHack.exe.config\"));\n if (isCompileFolder)\n return null;\n\n return gameDir.FullName;\n }\n\n /// Get the absolute path to the content folder for a given game, if found.\n /// The absolute path to the game folder.\n private string FindContentPath(string gamePath)\n {\n if (gamePath == null)\n return null;\n\n foreach (string relativePath in this.GetPossibleRelativeContentPaths())\n {\n DirectoryInfo folder = new DirectoryInfo(Path.Combine(gamePath, relativePath));\n if (folder.Exists)\n return folder.FullName;\n }\n\n return null;\n }\n\n /// Get the possible relative paths for the current platform.\n private IEnumerable GetPossibleRelativeContentPaths()\n {\n // under game folder on most platforms\n if (this.Platform != Platform.Mac)\n yield return \"Content\";\n\n // macOS\n else\n {\n // Steam paths\n // - game path: StardewValley/Contents/MacOS\n // - content: StardewValley/Contents/Resources/Content\n yield return \"../Resources/Content\";\n\n // GOG paths\n // - game path: Stardew Valley.app/Contents/MacOS\n // - content: Stardew Valley.app/Resources/Content\n yield return \"../../Resources/Content\";\n }\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/UnpackContext.cs",
"content": "using System.Collections.Generic;\nusing System.IO;\nusing StardewXnbHack.ProgressHandling;\n\nnamespace StardewXnbHack.Framework;\n\n/// The context info for the current unpack run.\ninternal class UnpackContext : IUnpackContext\n{\n /*********\n ** Accessors\n *********/\n /// \n public string GamePath { get; set; }\n\n /// \n public string ContentPath { get; set; }\n\n /// \n public string ExportPath { get; set; }\n\n /// \n public IEnumerable Files { get; set; }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/BaseAssetWriter.cs",
"content": "using System;\nusing Force.DeepCloner;\nusing Microsoft.Xna.Framework.Content;\nusing Newtonsoft.Json;\nusing StardewModdingAPI.Toolkit.Serialization;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// The base class for an asset writer.\ninternal abstract class BaseAssetWriter : IAssetWriter\n{\n /*********\n ** Private methods\n *********/\n /// The settings to use when serializing JSON.\n private readonly Lazy JsonSettings;\n\n\n /*********\n ** Public methods\n *********/\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public abstract bool CanWrite(object asset);\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public abstract bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error);\n\n\n /*********\n ** Protected methods\n *********/\n /// Construct an instance.\n /// Whether to ignore members marked which match the default value.\n protected BaseAssetWriter(bool omitDefaultFields = false)\n {\n this.JsonSettings = new(() => BaseAssetWriter.GetJsonSerializerSettings(omitDefaultFields));\n }\n\n /// Get a text representation for the given asset.\n /// The asset to serialize.\n protected string FormatData(object asset)\n {\n return JsonConvert.SerializeObject(asset, this.JsonSettings.Value);\n }\n\n /// Get the recommended file extension for a data file formatted with .\n protected string GetDataExtension()\n {\n return \"json\";\n }\n\n /// Get the serializer settings to apply when writing JSON.\n /// Whether to ignore members marked which match the default value.\n private static JsonSerializerSettings GetJsonSerializerSettings(bool omitDefaultFields = false)\n {\n JsonHelper jsonHelper = new();\n JsonSerializerSettings settings = jsonHelper.JsonSettings.DeepClone();\n\n settings.ContractResolver = new IgnoreDefaultOptionalPropertiesResolver(omitDefaultFields);\n\n return settings;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/DataWriter.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing System.IO;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes and assets to disk.\ninternal class DataWriter : BaseAssetWriter\n{\n /*********\n ** Public methods\n *********/\n /// \n public DataWriter(bool omitDefaultFields)\n : base(omitDefaultFields) { }\n\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public override bool CanWrite(object asset)\n {\n Type type = asset.GetType();\n type = type.IsGenericType ? type.GetGenericTypeDefinition() : type;\n\n return\n type == typeof(Dictionary<,>)\n || type == typeof(List<>)\n || type.FullName?.StartsWith(\"StardewValley.GameData.\") == true;\n }\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public override bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error)\n {\n File.WriteAllText($\"{toPathWithoutExtension}.{this.GetDataExtension()}\", this.FormatData(asset));\n\n error = null;\n return true;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/IAssetWriter.cs",
"content": "using StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes assets to disk.\ninternal interface IAssetWriter\n{\n /*********\n ** Methods\n *********/\n /// Whether the writer can handle a given asset.\n /// The asset value.\n bool CanWrite(object asset);\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error);\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/IgnoreDefaultOptionalPropertiesResolver.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Reflection;\nusing Microsoft.Xna.Framework.Content;\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Serialization;\nusing Sickhead.Engine.Util;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// A Json.NET contract resolver which ignores properties marked with , or (optionally) marked with the default value.\ninternal class IgnoreDefaultOptionalPropertiesResolver : DefaultContractResolver\n{\n /*********\n ** Fields\n *********/\n /// Whether to ignore members marked which match the default value.\n private readonly bool OmitDefaultValues;\n\n /// The default values for fields and properties marked .\n private readonly Dictionary> DefaultValues = new();\n\n\n /*********\n ** Public methods\n *********/\n /// Construct an instance.\n /// Whether to ignore members marked which match the default value.\n public IgnoreDefaultOptionalPropertiesResolver(bool omitDefaultValues)\n {\n this.OmitDefaultValues = omitDefaultValues;\n }\n\n\n /*********\n ** Protected methods\n *********/\n /// \n protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)\n {\n JsonProperty property = base.CreateProperty(member, memberSerialization);\n\n // property marked ignore\n if (member.GetCustomAttribute() != null)\n property.ShouldSerialize = _ => false;\n\n // property marked optional which matches default value\n else if (this.OmitDefaultValues)\n {\n Dictionary? optionalMembers = this.GetDefaultValues(member.DeclaringType);\n if (optionalMembers != null && optionalMembers.TryGetValue(member.Name, out object defaultValue))\n {\n property.ShouldSerialize = instance =>\n {\n object value = member.GetValue(instance);\n return !defaultValue?.Equals(value) ?? value is not null;\n };\n }\n }\n\n return property;\n }\n\n /// The default values for a type's fields and properties marked , if any.\n /// The type whose fields and properties to get default values for.\n /// Returns a dictionary of default values by member name if any were found, else null.\n private Dictionary? GetDefaultValues(Type type)\n {\n // skip invalid\n if (!type.IsClass || type.FullName is null || type.Namespace?.StartsWith(\"StardewValley\") != true)\n return null;\n\n // skip if already cached\n if (this.DefaultValues.TryGetValue(type.FullName, out Dictionary defaults))\n return defaults;\n\n // get members\n MemberInfo[] optionalMembers =\n (type.GetFields().OfType())\n .Concat(type.GetProperties())\n .Where(member => member.GetCustomAttribute()?.Optional is true)\n .ToArray();\n if (optionalMembers.Length == 0)\n return this.DefaultValues[type.FullName] = null;\n\n // get default instance\n object defaultInstance;\n try\n {\n defaultInstance = Activator.CreateInstance(type);\n }\n catch\n {\n return this.DefaultValues[type.FullName] = null;\n }\n\n // get default values\n defaults = new Dictionary();\n foreach (MemberInfo member in optionalMembers)\n defaults[member.Name] = member.GetValue(defaultInstance);\n return this.DefaultValues[type.FullName] = defaults;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/MapWriter.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Xml.Linq;\nusing StardewModdingAPI.Toolkit.Utilities;\nusing StardewValley;\nusing TMXTile;\nusing xTile;\nusing xTile.Dimensions;\nusing xTile.Layers;\nusing xTile.Tiles;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes assets to disk.\ninternal class MapWriter : BaseAssetWriter\n{\n /*********\n ** Fields\n *********/\n /// The actual size of a tile in the tilesheet.\n const int TileSize = Game1.tileSize / Game1.pixelZoom;\n\n /// The underlying map format handler.\n private readonly TMXFormat Format;\n\n\n /*********\n ** Public methods\n *********/\n /// Construct an instance.\n public MapWriter()\n {\n // init TMX support\n this.Format = new TMXFormat(Game1.tileSize / Game1.pixelZoom, Game1.tileSize / Game1.pixelZoom, Game1.pixelZoom, Game1.pixelZoom);\n }\n\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public override bool CanWrite(object asset)\n {\n return asset is Map;\n }\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public override bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error)\n {\n Map map = (Map)asset;\n\n // fix tile sizes (game overrides them in-memory)\n IDictionary tileSizes = new Dictionary();\n foreach (var layer in map.Layers)\n {\n tileSizes[layer] = layer.TileSize;\n layer.TileSize = new Size(MapWriter.TileSize, MapWriter.TileSize);\n }\n\n // fix image sources (game overrides them in-memory)\n IDictionary imageSources = new Dictionary();\n foreach (var sheet in map.TileSheets)\n {\n imageSources[sheet] = sheet.ImageSource;\n sheet.ImageSource = this.GetOriginalImageSource(relativePath, sheet.ImageSource);\n }\n\n // save file\n using (Stream stream = new MemoryStream())\n {\n // serialize to stream\n this.Format.Store(map, stream, DataEncodingType.CSV);\n\n // workaround: TMXTile doesn't indent the XML in newer .NET versions\n stream.Position = 0;\n var doc = XDocument.Load(stream);\n File.WriteAllText($\"{toPathWithoutExtension}.tmx\", \"\\n\" + doc.ToString());\n }\n\n // undo changes\n foreach (var layer in map.Layers)\n layer.TileSize = tileSizes[layer];\n foreach (var sheet in map.TileSheets)\n sheet.ImageSource = imageSources[sheet];\n\n error = null;\n return true;\n }\n\n\n /*********\n ** Public methods\n *********/\n /// Get the image source for a map tilesheet without the game's automatic path changes.\n /// The relative path to the map file within the content folder.\n /// The tilesheet image source.\n private string GetOriginalImageSource(string relativeMapPath, string imageSource)\n {\n string mapDirPath = PathUtilities.NormalizePath(Path.GetDirectoryName(relativeMapPath));\n string normalizedImageSource = PathUtilities.NormalizePath(imageSource);\n\n return normalizedImageSource.StartsWith($\"{mapDirPath}{PathUtilities.PreferredPathSeparator}\", StringComparison.OrdinalIgnoreCase)\n ? imageSource.Substring(mapDirPath.Length + 1)\n : imageSource;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/SpriteFontWriter.cs",
"content": "using System.IO;\nusing Microsoft.Xna.Framework;\nusing Microsoft.Xna.Framework.Graphics;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes assets to disk.\ninternal class SpriteFontWriter : BaseAssetWriter\n{\n /*********\n ** Public methods\n *********/\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public override bool CanWrite(object asset)\n {\n return asset is SpriteFont;\n }\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public override bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error)\n {\n SpriteFont font = (SpriteFont)asset;\n\n // get texture\n Texture2D texture = font.Texture;\n\n // save texture\n using (Stream stream = File.Create($\"{toPathWithoutExtension}.png\"))\n {\n if (texture.Format == SurfaceFormat.Dxt3) // MonoGame can't read DXT3 textures directly, need to export through GPU\n {\n using RenderTarget2D renderTarget = this.RenderWithGpu(texture);\n renderTarget.SaveAsPng(stream, texture.Width, texture.Height);\n }\n else\n texture.SaveAsPng(stream, texture.Width, texture.Height);\n }\n\n // save font data\n var data = new\n {\n font.LineSpacing,\n font.Spacing,\n font.DefaultCharacter,\n font.Characters,\n Glyphs = font.GetGlyphs()\n };\n File.WriteAllText($\"{toPathWithoutExtension}.{this.GetDataExtension()}\", this.FormatData(data));\n\n error = null;\n return true;\n }\n\n\n /*********\n ** Private methods\n *********/\n /// Draw a texture to a GPU render target.\n /// The texture to draw.\n private RenderTarget2D RenderWithGpu(Texture2D texture)\n {\n // set render target\n var gpu = texture.GraphicsDevice;\n RenderTarget2D target = new RenderTarget2D(gpu, texture.Width, texture.Height);\n gpu.SetRenderTarget(target);\n\n // render\n try\n {\n gpu.Clear(Color.Transparent); // set transparent background\n\n using SpriteBatch batch = new SpriteBatch(gpu);\n batch.Begin();\n batch.Draw(texture, Vector2.Zero, Color.White);\n batch.End();\n }\n finally\n {\n gpu.SetRenderTarget(null);\n }\n\n return target;\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/TextureWriter.cs",
"content": "using System.IO;\nusing Microsoft.Xna.Framework;\nusing Microsoft.Xna.Framework.Graphics;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes assets to disk.\ninternal class TextureWriter : BaseAssetWriter\n{\n /*********\n ** Public methods\n *********/\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public override bool CanWrite(object asset)\n {\n return asset is Texture2D;\n }\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public override bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error)\n {\n Texture2D texture = (Texture2D)asset;\n\n this.UnpremultiplyTransparency(texture);\n using (Stream stream = File.Create($\"{toPathWithoutExtension}.png\"))\n texture.SaveAsPng(stream, texture.Width, texture.Height);\n\n error = null;\n return true;\n }\n\n\n /*********\n ** Private methods\n *********/\n /// Reverse premultiplication applied to an image asset by the XNA content pipeline.\n /// The texture to adjust.\n private void UnpremultiplyTransparency(Texture2D texture)\n {\n Color[] data = new Color[texture.Width * texture.Height];\n texture.GetData(data);\n\n for (int i = 0; i < data.Length; i++)\n {\n Color pixel = data[i];\n if (pixel.A == 0)\n continue;\n\n data[i] = new Color(\n (byte)((pixel.R * 255) / pixel.A),\n (byte)((pixel.G * 255) / pixel.A),\n (byte)((pixel.B * 255) / pixel.A),\n pixel.A\n ); // don't use named parameters, which are inconsistent between MonoGame (e.g. 'alpha') and XNA (e.g. 'a')\n }\n\n texture.SetData(data);\n }\n}\n"
},
{
"path": "StardewXnbHack/Framework/Writers/XmlSourceWriter.cs",
"content": "using System.IO;\nusing BmFont;\nusing StardewModdingAPI.Toolkit.Utilities;\n\nnamespace StardewXnbHack.Framework.Writers;\n\n/// Writes assets to disk.\ninternal class XmlSourceWriter : BaseAssetWriter\n{\n /*********\n ** Public methods\n *********/\n /// Whether the writer can handle a given asset.\n /// The asset value.\n public override bool CanWrite(object asset)\n {\n return asset is XmlSource;\n }\n\n /// Write an asset instance to disk.\n /// The asset value.\n /// The absolute path to the export file, without the file extension.\n /// The relative path within the content folder.\n /// The operating system running the unpacker.\n /// An error phrase indicating why writing to disk failed (if applicable).\n /// Returns whether writing to disk completed successfully.\n public override bool TryWriteFile(object asset, string toPathWithoutExtension, string relativePath, Platform platform, out string error)\n {\n XmlSource value = (XmlSource)asset;\n File.WriteAllText($\"{toPathWithoutExtension}.fnt\", value.Source);\n\n error = null;\n return true;\n }\n}\n"
},
{
"path": "StardewXnbHack/Program.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing System.Diagnostics;\nusing System.IO;\nusing System.Linq;\nusing System.Reflection;\nusing System.Text;\nusing Microsoft.Xna.Framework.Graphics;\nusing StardewModdingAPI.Toolkit.Utilities;\nusing StardewValley;\nusing StardewXnbHack.Framework;\nusing StardewXnbHack.Framework.Writers;\nusing StardewXnbHack.ProgressHandling;\n\nnamespace StardewXnbHack;\n\n/// The console app entry point.\npublic static class Program\n{\n /*********\n ** Fields\n *********/\n /// The relative paths to search for unresolved assembly files.\n private static readonly string[] RelativeAssemblyProbePaths =\n {\n \"\", // app directory\n \"smapi-internal\"\n };\n\n\n /*********\n ** Public methods\n *********/\n /// The console app entry method.\n /// The command-line arguments.\n internal static void Main(string[] args)\n {\n // set window title\n Console.Title = $\"StardewXnbHack {Program.GetUnpackerVersion()}\";\n\n // check platform\n Program.AssertPlatform();\n\n // Add fallback assembly resolution that loads DLLs from a 'smapi-internal' subfolder,\n // so it can be run from the game folder. This must be set before any references to\n // game or toolkit types (including IAssetWriter which references the toolkit's\n // Platform enum).\n AppDomain.CurrentDomain.AssemblyResolve += Program.CurrentDomain_AssemblyResolve;\n\n // launch app\n try\n {\n Program.Run(args);\n }\n catch (Exception ex)\n {\n // not in game folder\n if (ex is FileNotFoundException fileNotFoundEx)\n {\n AssemblyName assemblyName = new AssemblyName(fileNotFoundEx.FileName);\n if (assemblyName.Name == \"Stardew Valley\")\n {\n Console.WriteLine(\"Oops! StardewXnbHack must be placed in the Stardew Valley game folder.\\nSee instructions: https://github.com/Pathoschild/StardewXnbHack#readme.\");\n DefaultConsoleLogger.PressAnyKeyToExit();\n return;\n }\n }\n\n // generic unhandled exception\n Console.WriteLine(\"Oops! Something went wrong running the unpacker:\");\n Console.WriteLine(ex.ToString());\n DefaultConsoleLogger.PressAnyKeyToExit();\n }\n }\n\n /// Unpack all assets in the content folder and store them in the output folder.\n /// The command-line arguments.\n /// The game instance through which to unpack files, or null to launch a temporary internal instance.\n /// The absolute path to the game folder, or null to auto-detect it.\n /// Get a custom progress update logger, or null to use the default console logging. Receives the unpack context and default logger as arguments.\n /// Whether the default logger should show a 'press any key to exit' prompt when it finishes.\n public static void Run(string[] args, GameRunner game = null, string gamePath = null, Func getLogger = null, bool showPressAnyKeyToExit = true)\n {\n // init logging\n UnpackContext context = new UnpackContext();\n IProgressLogger logger = new DefaultConsoleLogger(context, showPressAnyKeyToExit);\n\n try\n {\n // get override logger\n if (getLogger != null)\n logger = getLogger(context, logger);\n\n // read command-line arguments\n bool omitDefaultFields = args.Contains(\"--clean\");\n\n // start log\n logger.OnStepChanged(ProgressStep.Started, $\"Running StardewXnbHack {Program.GetUnpackerVersion()}.{(omitDefaultFields ? \" Special options: omit default fields.\" : \"\")}\");\n\n // start timer\n Stopwatch timer = new Stopwatch();\n timer.Start();\n\n // get asset writers\n var assetWriters = new IAssetWriter[]\n {\n new MapWriter(),\n new SpriteFontWriter(),\n new TextureWriter(),\n new XmlSourceWriter(),\n new DataWriter(omitDefaultFields) // check last due to more expensive CanWrite\n };\n\n // get paths\n var platform = new PlatformContext();\n {\n if (platform.TryDetectGamePaths(gamePath, out gamePath, out string contentPath))\n {\n context.GamePath = gamePath;\n context.ContentPath = contentPath;\n }\n else\n {\n logger.OnFatalError(gamePath == null\n ? \"Can't find the Stardew Valley folder. Try running StardewXnbHack from the game folder instead.\"\n : $\"Can't find the content folder for the game at {gamePath}. Is the game installed correctly?\"\n );\n return;\n }\n }\n context.ExportPath = Path.Combine(context.GamePath, \"Content (unpacked)\");\n logger.OnStepChanged(ProgressStep.GameFound, $\"Found game folder: {context.GamePath}.\");\n\n // symlink files on Linux/Mac\n if (platform.Is(Platform.Linux, Platform.Mac))\n {\n foreach (string dirName in new[] { \"lib\", \"lib64\" })\n {\n string fullPath = Path.Combine(context.GamePath, dirName);\n if (!Directory.Exists(dirName))\n Process.Start(\"ln\", $\"-sf \\\"{fullPath}\\\"\");\n }\n }\n\n // load game instance\n bool disposeGame = false;\n if (game == null)\n {\n logger.OnStepChanged(ProgressStep.LoadingGameInstance, \"Loading game instance...\");\n game = Program.CreateTemporaryGameInstance(platform, context.ContentPath);\n disposeGame = true;\n }\n\n // unpack files\n try\n {\n logger.OnStepChanged(ProgressStep.UnpackingFiles, $\"Unpacking files for Stardew Valley {Program.GetGameVersion()}...\");\n\n // collect files\n DirectoryInfo contentDir = new DirectoryInfo(context.ContentPath);\n FileInfo[] files = contentDir.EnumerateFiles(\"*.xnb\", SearchOption.AllDirectories).ToArray();\n context.Files = files;\n\n // write assets\n foreach (FileInfo file in files)\n {\n // prepare paths\n string assetName = file.FullName.Substring(context.ContentPath.Length + 1, file.FullName.Length - context.ContentPath.Length - 5); // remove root path + .xnb extension\n string relativePath = $\"{assetName}.xnb\";\n string fileExportPath = Path.Combine(context.ExportPath, assetName);\n Directory.CreateDirectory(Path.GetDirectoryName(fileExportPath));\n\n // fallback logic\n void ExportRawXnb()\n {\n File.Copy(file.FullName, $\"{fileExportPath}.xnb\", overwrite: true);\n }\n\n // show progress bar\n logger.OnFileUnpacking(assetName);\n\n // read asset\n object asset;\n try\n {\n asset = game.Content.Load