remove DumpMetadata option

This commit is contained in:
Jesse Plamondon-Willard 2020-01-04 22:32:23 -05:00
parent 93459a5e37
commit d804526d52
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
5 changed files with 2 additions and 46 deletions

View File

@ -38,6 +38,7 @@
* Added direct `Console` access to paranoid mode warnings. * Added direct `Console` access to paranoid mode warnings.
* Improved error messages for `TargetParameterCountException` when using the reflection API. * Improved error messages for `TargetParameterCountException` when using the reflection API.
* `helper.Read/WriteSaveData` can now be used while a save is being loaded (e.g. within a `Specialized.LoadStageChanged` event). * `helper.Read/WriteSaveData` can now be used while a save is being loaded (e.g. within a `Specialized.LoadStageChanged` event).
* Removed `DumpMetadata` option. It was only meant for specific debugging cases, but players would occasionally enable it incorrectly and then report crashes.
* Fixed private textures loaded from content packs not having their `Name` field set. * Fixed private textures loaded from content packs not having their `Name` field set.
* For SMAPI developers: * For SMAPI developers:

View File

@ -1,21 +0,0 @@
namespace StardewModdingAPI.Framework.Models
{
/// <summary>Metadata exported to the mod folder.</summary>
internal class ModFolderExport
{
/// <summary>When the export was generated.</summary>
public string Exported { get; set; }
/// <summary>The absolute path of the mod folder.</summary>
public string ModFolderPath { get; set; }
/// <summary>The game version which last loaded the mods.</summary>
public string GameVersion { get; set; }
/// <summary>The SMAPI version which last loaded the mods.</summary>
public string ApiVersion { get; set; }
/// <summary>The detected mods.</summary>
public IModMetadata[] Mods { get; set; }
}
}

View File

@ -25,8 +25,7 @@ namespace StardewModdingAPI.Framework.Models
[nameof(GitHubProjectName)] = "Pathoschild/SMAPI", [nameof(GitHubProjectName)] = "Pathoschild/SMAPI",
[nameof(WebApiBaseUrl)] = "https://smapi.io/api/", [nameof(WebApiBaseUrl)] = "https://smapi.io/api/",
[nameof(VerboseLogging)] = false, [nameof(VerboseLogging)] = false,
[nameof(LogNetworkTraffic)] = false, [nameof(LogNetworkTraffic)] = false
[nameof(DumpMetadata)] = false
}; };
/// <summary>The default values for <see cref="SuppressUpdateChecks"/>, to log changes if different.</summary> /// <summary>The default values for <see cref="SuppressUpdateChecks"/>, to log changes if different.</summary>
@ -64,9 +63,6 @@ namespace StardewModdingAPI.Framework.Models
/// <summary>Whether SMAPI should log network traffic. Best combined with <see cref="VerboseLogging"/>, which includes network metadata.</summary> /// <summary>Whether SMAPI should log network traffic. Best combined with <see cref="VerboseLogging"/>, which includes network metadata.</summary>
public bool LogNetworkTraffic { get; set; } public bool LogNetworkTraffic { get; set; }
/// <summary>Whether to generate a file in the mods folder with detailed metadata about the detected mods.</summary>
public bool DumpMetadata { get; set; }
/// <summary>The colors to use for text written to the SMAPI console.</summary> /// <summary>The colors to use for text written to the SMAPI console.</summary>
public ColorSchemeConfig ConsoleColors { get; set; } public ColorSchemeConfig ConsoleColors { get; set; }

View File

@ -435,20 +435,6 @@ namespace StardewModdingAPI.Framework
mods = resolver.ProcessDependencies(mods, modDatabase).ToArray(); mods = resolver.ProcessDependencies(mods, modDatabase).ToArray();
this.LoadMods(mods, this.Toolkit.JsonHelper, this.ContentCore, modDatabase); this.LoadMods(mods, this.Toolkit.JsonHelper, this.ContentCore, modDatabase);
// write metadata file
if (this.Settings.DumpMetadata)
{
ModFolderExport export = new ModFolderExport
{
Exported = DateTime.UtcNow.ToString("O"),
ApiVersion = Constants.ApiVersion.ToString(),
GameVersion = Constants.GameVersion.ToString(),
ModFolderPath = this.ModsPath,
Mods = mods
};
this.Toolkit.JsonHelper.WriteJsonFile(Path.Combine(Constants.LogDir, $"{Constants.LogNamePrefix}metadata-dump.json"), export);
}
// check for updates // check for updates
this.CheckForUpdatesAsync(mods); this.CheckForUpdatesAsync(mods);
} }

View File

@ -59,12 +59,6 @@ The default values are mirrored in StardewModdingAPI.Framework.Models.SConfig to
*/ */
"LogNetworkTraffic": false, "LogNetworkTraffic": false,
/**
* Whether to generate a 'SMAPI-latest.metadata-dump.json' file in the logs folder with the full mod
* metadata for detected mods. This is only needed when troubleshooting some cases.
*/
"DumpMetadata": false,
/** /**
* The colors to use for text written to the SMAPI console. * The colors to use for text written to the SMAPI console.
* *