detect & fix broken community center bundles

This commit is contained in:
Jesse Plamondon-Willard 2020-12-26 02:08:53 -05:00
parent 5a8a684e22
commit 49c192fc47
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
2 changed files with 42 additions and 1 deletions

View File

@ -9,7 +9,7 @@
## Upcoming release
* For players:
* Fixed community center bundle corruption for non-English players.
* Fixed community center bundles broken for non-English saves created in SMAPI 3.8.0. Affected saves will be fixed automatically next time you load them.
* For modders:
* World events are now raised for the volcano levels.

View File

@ -765,6 +765,9 @@ namespace StardewModdingAPI.Framework
this.Monitor.Log(context);
// apply save fixes
this.ApplySaveFixes();
// raise events
this.OnLoadStageChanged(LoadStage.Ready);
events.SaveLoaded.RaiseEmpty();
@ -1054,6 +1057,44 @@ namespace StardewModdingAPI.Framework
this.EventManager.ReturnedToTitle.RaiseEmpty();
}
/// <summary>Apply fixes to the save after it's loaded.</summary>
private void ApplySaveFixes()
{
// get last SMAPI version used with this save
const string migrationKey = "Pathoschild.SMAPI/last-version";
if (!Game1.CustomData.TryGetValue(migrationKey, out string rawVersion) || !SemanticVersion.TryParse(rawVersion, out ISemanticVersion lastVersionRun))
lastVersionRun = new SemanticVersion(3, 8, 0);
// fix bundle corruption in SMAPI 3.8.0
// For non-English players who created a new save in SMAPI 3.8.0, bundle data was
// incorrectly translated which caused the code to crash whenever the game tried to
// read it.
if (lastVersionRun.IsOlderThan(new SemanticVersion(3, 8, 1)))
{
bool? hasInvalidBundleData = Game1.netWorldState?.Value
?.BundleData
?.Values
?.Any(raw => raw != null && raw.Split('/').Length > 5);
if (hasInvalidBundleData == true)
{
try
{
Game1.applySaveFix(SaveGame.SaveFixes.FixBotchedBundleData);
this.Monitor.Log("Found corrupted community center data due to a previous version of SMAPI, and fixed it automatically.", LogLevel.Info);
}
catch (Exception ex)
{
this.Monitor.Log("Found corrupted community center data due to a previous version of SMAPI, but was unable to fix it automatically.", LogLevel.Error);
this.Monitor.Log($"Technical details: {ex}");
}
}
}
// update last run
Game1.CustomData[migrationKey] = Constants.ApiVersion.ToString();
}
/// <summary>Raised after custom content is removed from the save data to avoid a crash.</summary>
internal void OnSaveContentRemoved()
{