Update to version 1.2.0-beta.1 with new features

- Renamed and added constants in `Constants.cs` for Better Chests integration.
- Introduced `GrabEmptyAsItem` and `SwapChests` properties in `ModConfig`.
- Added `carry_chests` console command in `ModEntry` for managing backups and help.
- Implemented slowness effect management in `OnOneSecondUpdateTicked`.
- Updated `ConfigMenu` to include new configuration options.
- Added patches in `ModPatches.cs` for `InventoryMenu` interactions.
- Renamed `InventoryHelper` to `ModExtensions` and updated methods.
- Updated multiple language files for new features and commands.
- Updated `FauxCore` subproject to a new commit hash.

Author: LeFauxMatt

CarryChests/CarryChests.csproj

@@ -6,7 +6,7 @@
 	<PropertyGroup>
 		<Name>Carry Chests</Name>
 		<Description>Allows you to pick up placed chests with items.</Description>
-		<Version>1.1.0</Version>
+		<Version>1.2.0-beta.1</Version>
 		<EnableHarmony>true</EnableHarmony>
 		<RootNamespace>LeFauxMods.CarryChest</RootNamespace>
 		<UniqueId>furyx639.CarryChest</UniqueId>

CarryChests/Constants.cs

@@ -2,15 +2,17 @@ namespace LeFauxMods.CarryChest;
 
 internal static class Constants
 {
-    public const string ColorKey = Prefix + "PlayerChoiceColor";
+    public const string BetterChestsColorKey = "furyx639.BetterChests-ProxyChestFactory-PlayerChoiceColor";
 
-    public const string FridgeKey = Prefix + "Fridge";
+    public const string BetterChestsFridgeKey = "furyx639.BetterChests-ProxyChestFactory-Fridge";
 
-    public const string GlobalInventoryKey = Prefix + "GlobalInventoryId";
+    public const string GlobalInventoryId = ModId + "-Backup";
+
+    public const string BetterChestsGlobalInventoryKey = "furyx639.BetterChests-ProxyChestFactory-GlobalInventoryId";
 
     public const string ModId = "furyx639.CarryChests";
 
-    public const string Prefix = "furyx639.BetterChests-ProxyChestFactory-";
+    public const string Prefix = ModId + "-Chest-";
 
     public const string SlowEffectKey = ModId + "/Slow";
 }

CarryChests/ModConfig.cs

@@ -14,12 +14,18 @@ internal class ModConfig : IModConfig<ModConfig>, IConfigWithLogAmount
     /// <summary>Gets or sets a value indicating whether to override using a tool against a chest.</summary>
     public bool OverrideTool { get; set; }
 
+    /// <summary>Gets or sets a value indicating whether empty chests will be picked up as items.</summary>
+    public bool GrabEmptyAsItem { get; set; }
+
     /// <summary>Gets or sets the amount the player will be slowed when carrying chests above the limit.</summary>
     public float SlownessAmount { get; set; } = -1f;
 
     /// <summary>Gets or sets the maximum number of chests the player can hold before being slowed.</summary>
     public int SlownessLimit { get; set; } = 1;
 
+    /// <summary>Gets or sets a value indicating whether to allow swapping.</summary>
+    public bool SwapChests { get; set; } = true;
+
     /// <summary>Gets or sets the number of chests the player can carry.</summary>
     public int TotalLimit { get; set; } = 3;
 
@@ -30,19 +36,23 @@ internal class ModConfig : IModConfig<ModConfig>, IConfigWithLogAmount
     public void CopyTo(ModConfig other)
     {
         other.LogAmount = this.LogAmount;
+        other.GrabEmptyAsItem = this.GrabEmptyAsItem;
         other.OpenHeldChest = this.OpenHeldChest;
         other.OverrideTool = this.OverrideTool;
         other.SlownessAmount = this.SlownessAmount;
         other.SlownessLimit = this.SlownessLimit;
+        other.SwapChests = this.SwapChests;
         other.TotalLimit = this.TotalLimit;
     }
 
     public string GetSummary() =>
         new StringBuilder()
+            .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.GrabEmptyAsItem),25}: {this.GrabEmptyAsItem}")
             .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.OpenHeldChest),25}: {this.OpenHeldChest}")
             .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.OverrideTool),25}: {this.OverrideTool}")
             .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.SlownessAmount),25}: {this.SlownessAmount}")
             .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.SlownessLimit),25}: {this.SlownessLimit}")
+            .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.SwapChests),25}: {this.SwapChests}")
             .AppendLine(CultureInfo.InvariantCulture, $"{nameof(this.TotalLimit),25}: {this.TotalLimit}")
             .ToString();
 }

CarryChests/ModEntry.cs

@@ -1,9 +1,13 @@
+using System.Globalization;
+using System.Text;
 using LeFauxMods.CarryChest.Services;
 using LeFauxMods.CarryChest.Utilities;
 using LeFauxMods.Common.Models;
 using LeFauxMods.Common.Utilities;
+using Microsoft.Xna.Framework;
 using StardewModdingAPI.Events;
 using StardewValley.Buffs;
+using StardewValley.Menus;
 using StardewValley.Objects;
 
 namespace LeFauxMods.CarryChest;
@@ -22,13 +26,93 @@ public override void Entry(IModHelper helper)
         ModPatches.Apply();
 
         // TBD: Command to access global inventory chests
+        helper.ConsoleCommands.Add("carry_chests", I18n.Command_CarryChests_Description(), OnCommand);
 
         // Events
         helper.Events.GameLoop.GameLaunched += this.OnGameLaunched;
         helper.Events.GameLoop.SaveLoaded += this.OnSaveLoaded;
         helper.Events.GameLoop.ReturnedToTitle += this.OnReturnedToTitle;
     }
 
+    private static void OnCommand(string arg1, string[] arg2)
+    {
+        switch (arg2.ElementAtOrDefault(0)?.ToLower(CultureInfo.InvariantCulture))
+        {
+            case "backup" when !Context.IsWorldReady:
+                Log.Info(I18n.Alert_CommandBackup_InvalidContext());
+                return;
+
+            case "backup":
+                Game1.activeClickableMenu = new ItemGrabMenu(ModState.Backups);
+                return;
+
+            case "help":
+                switch (arg2.ElementAtOrDefault(1)?.ToLower(CultureInfo.InvariantCulture))
+                {
+                    case "backup":
+                        Log.Info(I18n.Command_Backups_Description());
+                        return;
+
+                    case "help":
+                        Log.Info(I18n.Command_Help_Description());
+                        return;
+
+                    case null:
+                        Log.Info(
+                            new StringBuilder()
+                                .AppendLine("Commands:")
+                                .AppendLine()
+                                .AppendLine("carry_chests backup")
+                                .AppendLine(CultureInfo.InvariantCulture, $"\t{I18n.Command_Backups_Description()}")
+                                .AppendLine()
+                                .AppendLine("carry_chests help")
+                                .AppendLine(CultureInfo.InvariantCulture, $"\t{I18n.Command_Help_Description()}")
+                                .ToString());
+                        return;
+
+                    default:
+                        Log.Info(I18n.Command_Unknown_Description());
+                        return;
+                }
+
+            case null:
+                Log.Info(I18n.Command_CarryChests_Description());
+                return;
+
+            default:
+                Log.Info(I18n.Command_Unknown_Description());
+                return;
+        }
+    }
+
+    private static void OnOneSecondUpdateTicked(object? sender, OneSecondUpdateTickedEventArgs e)
+    {
+        // Add status effect to the player
+        if (Game1.player.Items.OfType<Chest>().Count() >= ModState.Config.SlownessLimit)
+        {
+            Game1.player.applyBuff(
+                new Buff(
+                    Constants.SlowEffectKey,
+                    duration: 60_000,
+                    iconTexture: Game1.buffsIcons,
+                    iconSheetIndex: 13,
+                    effects: new BuffEffects { Speed = { ModState.Config.SlownessAmount } },
+                    displayName: I18n.Effect_Overburdened()));
+
+            Log.Trace("Adding the slowness effect");
+            return;
+        }
+
+        if (!Game1.player.hasBuff(Constants.SlowEffectKey))
+        {
+            return;
+        }
+
+        // Remove status effect from the player
+        Game1.player.buffs.Remove(Constants.SlowEffectKey);
+        Log.Trace("Removing the slowness effect");
+    }
+
     private void OnGameLaunched(object? sender, GameLaunchedEventArgs e) =>
         _ = new ConfigMenu(this.Helper, this.ModManifest);
 
@@ -55,13 +139,13 @@ private void OnButtonPressed(object? sender, ButtonPressedEventArgs e)
                 return;
             }
 
-            if (InventoryHelper.SwapChest(chest))
+            if (ModState.Config.SwapChests && chest.TrySwap())
             {
                 this.Helper.Input.Suppress(e.Button);
                 return;
             }
 
-            if (InventoryHelper.PickUpChest(chest, ModState.Config.TotalLimit))
+            if (chest.TryCarry())
             {
                 this.Helper.Input.Suppress(e.Button);
                 _ = chest.Location.Objects.Remove(chest.TileLocation);
@@ -93,34 +177,6 @@ private void OnConfigChanged(ConfigChangedEventArgs<ModConfig> e)
         }
     }
 
-    private static void OnOneSecondUpdateTicked(object? sender, OneSecondUpdateTickedEventArgs e)
-    {
-        // Add status effect to the player
-        if (Game1.player.Items.OfType<Chest>().Count() >= ModState.Config.SlownessLimit)
-        {
-            Game1.player.applyBuff(
-                new Buff(
-                    Constants.SlowEffectKey,
-                    duration: 60_000,
-                    iconTexture: Game1.buffsIcons,
-                    iconSheetIndex: 13,
-                    effects: new BuffEffects { Speed = { ModState.Config.SlownessAmount } },
-                    displayName: I18n.Effect_Overburdened()));
-
-            Log.Trace("Adding the slowness effect");
-            return;
-        }
-
-        if (!Game1.player.hasBuff(Constants.SlowEffectKey))
-        {
-            return;
-        }
-
-        // Remove status effect from the player
-        Game1.player.buffs.Remove(Constants.SlowEffectKey);
-        Log.Trace("Removing the slowness effect");
-    }
-
     private void OnReturnedToTitle(object? sender, ReturnedToTitleEventArgs e)
     {
         this.Helper.Events.Input.ButtonPressed -= this.OnButtonPressed;
@@ -134,5 +190,66 @@ private void OnSaveLoaded(object? sender, SaveLoadedEventArgs e)
         {
             this.Helper.Events.GameLoop.OneSecondUpdateTicked += OnOneSecondUpdateTicked;
         }
+
+        // Create missing backups
+        for (var i = 0; i < Game1.player.Items.Count; i++)
+        {
+            var item = Game1.player.Items[i];
+            if (item is not Chest chest)
+            {
+                if (item is null ||
+                    !item.modData.TryGetValue(Constants.BetterChestsGlobalInventoryKey, out var id) ||
+                    !Game1.player.team.globalInventories.ContainsKey(id))
+                {
+                    continue;
+                }
+
+                // Attempt to restore a Better Chest proxy
+                var color = Color.Black;
+                if (item.modData.TryGetValue(Constants.BetterChestsColorKey, out var colorString) &&
+                    int.TryParse(colorString, out var colorValue))
+                {
+                    var r = (byte)(colorValue & 0xFF);
+                    var g = (byte)((colorValue >> 8) & 0xFF);
+                    var b = (byte)((colorValue >> 16) & 0xFF);
+                    color = new Color(r, g, b);
+                }
+
+                chest = new Chest(true, item.ItemId)
+                {
+                    GlobalInventoryId = id,
+                    fridge = { Value = item.modData.ContainsKey(Constants.BetterChestsFridgeKey) },
+                    playerChoiceColor = { Value = color }
+                };
+
+                chest.CopyFieldsFrom(item);
+                _ = chest.modData.Remove(Constants.BetterChestsFridgeKey);
+                _ = chest.modData.Remove(Constants.BetterChestsColorKey);
+                _ = chest.modData.Remove(Constants.BetterChestsGlobalInventoryKey);
+                Game1.player.Items[i] = chest;
+            }
+
+            _ = ModState.Backups.TryAddBackup(chest, Constants.Prefix);
+        }
+
+        // Create generic backups for any missing
+        foreach (var (id, _) in Game1.player.team.globalInventories.Pairs)
+        {
+            // Only create backups for known ids
+            if (!id.StartsWith(Constants.Prefix, StringComparison.OrdinalIgnoreCase) &&
+                !id.StartsWith("furyx639.BetterChests-ProxyChestFactory-", StringComparison.OrdinalIgnoreCase))
+            {
+                continue;
+            }
+
+            // Do not create if backup already exists
+            if (ModState.Backups.OfType<Chest>()
+                .Any(chest => chest.GlobalInventoryId.Equals(id, StringComparison.OrdinalIgnoreCase)))
+            {
+                continue;
+            }
+
+            ModState.Backups.Add(new Chest(true) { GlobalInventoryId = id });
+        }
     }
 }

CarryChests/Services/ConfigMenu.cs

@@ -65,5 +65,12 @@ private void SetupMenu()
             static value => Config.OverrideTool = value,
             I18n.ConfigOption_OverrideToool_Name,
             I18n.ConfigOption_OverrideTool_Description);
+
+        this.api.AddBoolOption(
+            this.manifest,
+            static () => Config.SwapChests,
+            static value => Config.SwapChests = value,
+            I18n.ConfigOption_SwapChests_Name,
+            I18n.ConfigOption_SwapChests_Description);
     }
 }