Add toggle options for preview and preview nearby

.timetracker

@@ -1,5 +1,5 @@
 {
- "total": 90094,
+ "total": 75390,
  "sessions": [
   {
    "begin": "2026-03-11T23:50:47+01:00",
@@ -75,81 +75,6 @@
    "begin": "2026-03-28T03:48:55+01:00",
    "end": "2026-03-28T04:27:34+01:00",
    "duration": 2319
-  },
-  {
-   "begin": "2026-05-22T17:40:18+02:00",
-   "end": "2026-05-22T18:03:45+02:00",
-   "duration": 1406
-  },
-  {
-   "begin": "2026-05-22T18:30:12+02:00",
-   "end": "2026-05-22T18:34:35+02:00",
-   "duration": 262
-  },
-  {
-   "begin": "2026-05-22T18:34:49+02:00",
-   "end": "2026-05-22T18:38:39+02:00",
-   "duration": 229
-  },
-  {
-   "begin": "2026-05-22T18:38:55+02:00",
-   "end": "2026-05-22T18:39:22+02:00",
-   "duration": 27
-  },
-  {
-   "begin": "2026-05-22T18:58:35+02:00",
-   "end": "2026-05-22T19:03:47+02:00",
-   "duration": 311
-  },
-  {
-   "begin": "2026-05-22T19:03:52+02:00",
-   "end": "2026-05-22T19:05:29+02:00",
-   "duration": 96
-  },
-  {
-   "begin": "2026-05-22T19:05:33+02:00",
-   "end": "2026-05-22T19:12:57+02:00",
-   "duration": 444
-  },
-  {
-   "begin": "2026-05-22T19:13:27+02:00",
-   "end": "2026-05-22T19:21:36+02:00",
-   "duration": 489
-  },
-  {
-   "begin": "2026-05-22T19:22:06+02:00",
-   "end": "2026-05-22T19:47:51+02:00",
-   "duration": 1545
-  },
-  {
-   "begin": "2026-05-22T20:11:03+02:00",
-   "end": "2026-05-22T20:42:49+02:00",
-   "duration": 1906
-  },
-  {
-   "begin": "2026-05-23T00:13:03+02:00",
-   "end": "2026-05-23T00:33:04+02:00",
-   "duration": 1201
-  },
-  {
-   "begin": "2026-05-23T00:34:04+02:00",
-   "end": "2026-05-23T01:10:47+02:00",
-   "duration": 2202
-  },
-  {
-   "begin": "2026-05-23T01:10:47+02:00",
-   "end": "2026-05-23T01:38:03+02:00",
-   "duration": 1636
-  },
-  {
-   "begin": "2026-05-23T01:38:05+02:00",
-   "end": "2026-05-23T02:04:35+02:00",
-   "duration": 1590
-  },
-  {
-   "begin": "2026-05-23T02:05:09+02:00",
-   "end": "2026-05-23T02:27:49+02:00",
-   "duration": 1360
   }
  ]
 }

.vscode/tasks.json

@@ -4,9 +4,9 @@
         {
             "label": "check env",
             "type": "shell",
-            "command": "if [ \"${input:buildConfig}\" = \"Version22\" ]; then [ -n \"$VINTAGE_STORY_22\" ] || { echo 'ERROR: VINTAGE_STORY_22 is not set'; exit 1; }; [ -n \"$VINTAGE_STORY_DATA_22\" ] || { echo 'ERROR: VINTAGE_STORY_DATA_22 is not set'; exit 1; }; else [ -n \"$VINTAGE_STORY_21\" ] || { echo 'ERROR: VINTAGE_STORY_21 is not set'; exit 1; }; [ -n \"$VINTAGE_STORY_DATA_21\" ] || { echo 'ERROR: VINTAGE_STORY_DATA_21 is not set'; exit 1; }; fi",
+            "command": "[ -n \"$VINTAGE_STORY\" ] || { echo 'ERROR: VINTAGE_STORY is not set'; exit 1; }; [ -n \"$VINTAGE_STORY_DATA\" ] || { echo 'ERROR: VINTAGE_STORY_DATA is not set'; exit 1; }",
             "windows": {
-                "command": "if ('${input:buildConfig}' -eq 'Version22') { if (-not $env:VINTAGE_STORY_22) { Write-Host 'ERROR: VINTAGE_STORY_22 is not set'; exit 1 }; if (-not $env:VINTAGE_STORY_DATA_22) { Write-Host 'ERROR: VINTAGE_STORY_DATA_22 is not set'; exit 1 } } else { if (-not $env:VINTAGE_STORY_21) { Write-Host 'ERROR: VINTAGE_STORY_21 is not set'; exit 1 }; if (-not $env:VINTAGE_STORY_DATA_21) { Write-Host 'ERROR: VINTAGE_STORY_DATA_21 is not set'; exit 1 } }"
+                "command": "if (-not $env:VINTAGE_STORY) { Write-Host 'ERROR: VINTAGE_STORY is not set'; exit 1 }; if (-not $env:VINTAGE_STORY_DATA) { Write-Host 'ERROR: VINTAGE_STORY_DATA is not set'; exit 1 }"
             },
             "problemMatcher": []
         },

ChestPreview/ChestPreview/ChestPreview.csproj

@@ -6,8 +6,6 @@
     <OutputPath>bin\$(Configuration)\Mods\mod</OutputPath>
     <Nullable>enable</Nullable>
     <Configurations>Debug;Release;Version22</Configurations>
-    <VINTAGE_STORY>$(VINTAGE_STORY_21)</VINTAGE_STORY>
-    <VINTAGE_STORY_DATA>$(VINTAGE_STORY_DATA_21)</VINTAGE_STORY_DATA>
     <VS_CONFIGLIB Condition="'$(VS_CONFIGLIB)' == ''">$([System.Environment]::GetEnvironmentVariable('VS_CONFIGLIB'))</VS_CONFIGLIB>
     <ConfigLibAvailable Condition="'$(VS_CONFIGLIB)' != '' and Exists('$(VS_CONFIGLIB)')">true</ConfigLibAvailable>
     <DefineConstants Condition="'$(ConfigLibAvailable)' == 'true'">$(DefineConstants);CONFIGLIB</DefineConstants>

ChestPreview/ChestPreview/Configs/Config.cs

@@ -4,6 +4,8 @@ public sealed class Config
 {
     public string Mode { get; set; } = PreviewModes.UNDER_CURSOR;
 
+    public bool HoldKey { get; set; } = true;
+
     public bool BillboardIgnoreFront { get; set; } = false;
 
     public int BillboardColumnsPerBlock { get; set; } = 4;
@@ -19,4 +21,8 @@ public sealed class Config
     public string BlacklistedContainers { get; set; } = "";
 
     public bool GroundStorageOnlyContainers { get; set; } = true;
+
+    public bool TogglePreview { get; set; } = false;
+
+    public bool TogglePreviewNearby { get; set; } = false;
 }

ChestPreview/ChestPreview/Configs/State.cs

@@ -1,7 +0,0 @@
-namespace ChestPreview.Configs;
-
-public class State
-{
-    public bool PreviewNearbyToggleActive { get; set; } = false;
-    public bool PreviewToggleActive { get; set; } = false;
-}

ChestPreview/ChestPreview/Core/ChestPreviewModSystem.cs

@@ -10,12 +10,9 @@ namespace ChestPreview.Core;
 public class ChestPreviewModSystem : ModSystem
 {
     internal const string CONFIG_FILENAME = "chestpreview.json";
-    internal const string STATE_FILENAME = "chestpreview-state.json";
     internal const string CONFIGLIB_DOMAIN = "chestpreview";
     internal const string PREVIEW_CONTAINERS_HOTKEY_CODE = "chestpreview-preview-containers";
     internal const string PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE = "chestpreview-preview-containers-nearby";
-    internal const string TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE = "chestpreview-preview-containers-toggle";
-    internal const string TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE = "chestpreview-preview-containers-nearby-toggle";
 
     private Config config = new();
     private CardRenderer? cardRenderer;
@@ -23,7 +20,8 @@ public class ChestPreviewModSystem : ModSystem
     private StorageHoverHudRenderer? storageHoverHudRenderer;
     private WorldBillboardRenderer? worldBillboardRenderer;
 
-    public State State { get; } = new();
+    public bool PreviewNearbyToggleState { get; private set; } = false;
+    public bool PreviewToggleState { get; private set; } = false;
 
     public override bool ShouldLoad(EnumAppSide forSide) => forSide is EnumAppSide.Client;
 
@@ -42,20 +40,20 @@ public class ChestPreviewModSystem : ModSystem
         api.Event.RegisterRenderer(worldBillboardRenderer, EnumRenderStage.AfterOIT, "chestpreview-world-billboard-preview");
 
         api.Input.SetHotKeyHandler(
-            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE,
+            hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE,
             keycomb =>
             {
-                State.PreviewToggleActive = !State.PreviewToggleActive;
-                api.StoreModConfig(State, STATE_FILENAME);
+                if (!config.TogglePreview) return false;
+                this.PreviewToggleState = !this.PreviewToggleState;
                 return true;
             });
 
         api.Input.SetHotKeyHandler(
-            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
+            hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
             keycomb =>
             {
-                State.PreviewNearbyToggleActive = !State.PreviewNearbyToggleActive;
-                api.StoreModConfig(State, STATE_FILENAME);
+                if (!config.TogglePreviewNearby) return false;
+                this.PreviewNearbyToggleState = !this.PreviewNearbyToggleState;
                 return true;
             });
     }
@@ -86,14 +84,10 @@ public class ChestPreviewModSystem : ModSystem
     public Config LoadClientConfig(ICoreClientAPI api)
     {
         Config config;
-        State state;
 
         try
         {
             config = api.LoadModConfig<Config>(CONFIG_FILENAME) ?? new Config();
-            state = api.LoadModConfig<State>(STATE_FILENAME) ?? new State();
-            State.PreviewNearbyToggleActive = state.PreviewNearbyToggleActive;
-            State.PreviewToggleActive = state.PreviewToggleActive;
         }
         catch (Exception ex)
         {
@@ -112,7 +106,6 @@ public class ChestPreviewModSystem : ModSystem
         config.PreviewNearbyRadius = config.PreviewNearbyRadius;
 
         api.StoreModConfig(config, CONFIG_FILENAME);
-        api.StoreModConfig(State, STATE_FILENAME);
         return config;
     }
 
@@ -135,23 +128,5 @@ public class ChestPreviewModSystem : ModSystem
             altPressed: false,
             ctrlPressed: true,
             shiftPressed: false);
-
-        api.Input.RegisterHotKey(
-            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE,
-            name: Lang.Get("chestpreview:hotkey-preview-container-toggle"),
-            key: GlKeys.Unknown,
-            type: HotkeyType.HelpAndOverlays,
-            altPressed: false,
-            ctrlPressed: false,
-            shiftPressed: false);
-
-        api.Input.RegisterHotKey(
-            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
-            name: Lang.Get("chestpreview:hotkey-preview-containers-nearby-toggle"),
-            key: GlKeys.Unknown,
-            type: HotkeyType.HelpAndOverlays,
-            altPressed: false,
-            ctrlPressed: false,
-            shiftPressed: false);
     }
 }

ChestPreview/ChestPreview/PreviewTargetProvider.cs

@@ -24,7 +24,7 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
     private readonly Config config = config;
     private readonly List<BlockEntity> nearbyContainerEntities = [];
     private float nearbyScanAccumulator;
-    private readonly Lazy<State> state = new(() => api.ModLoader.GetModSystem<ChestPreviewModSystem>().State);
+    private Lazy<ChestPreviewModSystem> coreModSystem = new Lazy<ChestPreviewModSystem>(() => api.ModLoader.GetModSystem<ChestPreviewModSystem>());
 
     public void CollectTargets(float deltaTime, List<PreviewTarget> targets)
     {
@@ -84,16 +84,39 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
 
     private string GetActiveMode()
     {
-        var previewKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE);
-        var previewNearbyKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE);
-
-        if (state.Value.PreviewNearbyToggleActive || previewNearbyKeyHeld)
+        if (IsPreviewContainersNearbyActive())
             return PreviewModes.ON_NEARBY_CONTAINERS;
 
-        if (state.Value.PreviewToggleActive || previewKeyHeld)
-            return PreviewModes.Normalize(config.Mode);
+        return IsPreviewContainersActive() ? PreviewModes.Normalize(config.Mode) : PreviewModes.NONE;
+    }
 
-        return PreviewModes.NONE;
+    private bool IsPreviewContainersNearbyActive()
+    {
+        if (config.TogglePreviewNearby)
+        {
+            return coreModSystem.Value.PreviewNearbyToggleState;
+        }
+        else
+        {
+            return IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE);
+        }
+    }
+
+    private bool IsPreviewContainersActive()
+    {
+        if (config.TogglePreview)
+        {
+            return coreModSystem.Value.PreviewToggleState;
+        }
+        else if (config.HoldKey)
+        {
+            return IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE);
+        }
+        else
+        {
+            // Always
+            return true;
+        }
     }
 
     private bool IsHotkeyHeld(string hotkeyCode)

ChestPreview/ChestPreview/assets/chestpreview/config/configlib-patches.json

@@ -20,6 +20,13 @@
             ],
             "clientSide": true
         },
+        {
+            "code": "HoldKey",
+            "comment": "config-desc-HoldKey",
+            "type": "boolean",
+            "default": true,
+            "clientSide": true
+        },
         {
             "code": "BillboardIgnoreFront",
             "comment": "config-desc-BillboardIgnoreFront",
@@ -83,11 +90,25 @@
             "clientSide": true
         },
         {
-            "code": "GroundStorageOnlyContainers",
-            "comment": "config-desc-GroundStorageOnlyContainers",
-            "type": "boolean",
-            "default": true,
-            "clientSide": true
+          "code": "GroundStorageOnlyContainers",
+          "comment": "config-desc-GroundStorageOnlyContainers",
+          "type": "boolean",
+          "default": true,
+          "clientSide": true
+        },
+        {
+          "code": "TogglePreview",
+          "comment": "config-desc-TogglePreview",
+          "type": "boolean",
+          "default": false,
+          "clientSide": true
+        },
+        {
+          "code": "TogglePreviewNearby",
+          "comment": "config-desc-TogglePreviewNearby",
+          "type": "boolean",
+          "default": false,
+          "clientSide": true
         }
     ]
 }

ChestPreview/ChestPreview/assets/chestpreview/lang/en.json

@@ -1,9 +1,8 @@
 {
     "hotkey-preview-container": "Preview container",
     "hotkey-preview-containers-nearby": "Preview containers nearby",
-    "hotkey-preview-container-toggle": "Toggle preview container",
-    "hotkey-preview-containers-nearby-toggle": "Toggle preview on containers nearby",
     "config-desc-Mode": "Preview mode. Valid values: None, UnderCursor, OnHoveredContainer, OnNearbyContainers.",
+    "config-desc-HoldKey": "Previews only show while the \"Preview containers\" key is held.",
     "config-desc-BillboardIgnoreFront": "With this set to false, in-world previews show on the front side of containers. By setting this to true, the previews show on the side determined to be most visible.",
     "config-desc-BillboardColumnsPerBlock": "Columns per block width used for world billboards. For containers 2 blocks wide it's doubled.",
     "config-desc-ColumnsUnderCursor": "Columns in the UnderCursor mode.",
@@ -11,5 +10,7 @@
     "config-desc-WhitelistedContainersOnly": "If true, only container codes in WhitelistedContainers are handled.",
     "config-desc-GroundStorageOnlyContainers": "If true, groundstorage previews only appear when the stored item has its own inventory (for example bags/backpacks).",
     "config-desc-WhitelistedContainers": "Allowed container codes, separated by comma, semicolon, or spaces. No effectif WhitelistedContainersOnly==false.",
-    "config-desc-BlacklistedContainers": "Blocked container codes, separated by comma, semicolon, or spaces."
+    "config-desc-BlacklistedContainers": "Blocked container codes, separated by comma, semicolon, or spaces.",
+    "config-desc-TogglePreview": "If true, \"Preview container\" is toggled on/off with the key instead of being held. HoldKey will be ignored.",
+    "config-desc-TogglePreviewNearby": "If true, \"Preview containers nearby\" is toggled on/off with the key instead of being held. Note: Toggle may not work with modifier-only key combinations (e.g. Ctrl+Shift). You might need to reassign the hotkey."
 }

ChestPreview/ChestPreview/modinfo.json

@@ -7,7 +7,7 @@
         "OrekiWoof"
     ],
     "description": "see containers' contents without having to open them",
-    "version": "2.0.0",
+    "version": "1.2.0",
     "dependencies": {
         "game": "1.21.0"
     },

ChestPreview/ZZCakeBuild/CakeBuild.csproj

@@ -4,16 +4,11 @@
     <TargetFramework>net8.0</TargetFramework>
     <RunWorkingDirectory>$(MSBuildProjectDirectory)</RunWorkingDirectory>
     <Configurations>Debug;Release;Version22</Configurations>
-    <VINTAGE_STORY>$(VINTAGE_STORY_21)</VINTAGE_STORY>
     <VS_CONFIGLIB Condition="'$(VS_CONFIGLIB)' == ''">$([System.Environment]::GetEnvironmentVariable('VS_CONFIGLIB'))</VS_CONFIGLIB>
     <ConfigLibAvailable Condition="'$(VS_CONFIGLIB)' != '' and Exists('$(VS_CONFIGLIB)')">true</ConfigLibAvailable>
     <DefineConstants Condition="'$(ConfigLibAvailable)' == 'true'">$(DefineConstants);CONFIGLIB</DefineConstants>
   </PropertyGroup>
   
-  <PropertyGroup Condition="'$(Configuration)' == 'Version22'">
-    <VINTAGE_STORY>$(VINTAGE_STORY_22)</VINTAGE_STORY>
-  </PropertyGroup>
-  
   <ItemGroup>
     <PackageReference Include="Cake.Frosting" Version="5.0.0" />
     <PackageReference Include="Cake.Json" Version="7.0.1" />

readme.md

@@ -9,8 +9,8 @@
 
 ### Required env vars
 
-- `VINTAGE_STORY_21`: path to the 1.21 game install (on Windows default is %appdata%/VintageStory)
-- `VINTAGE_STORY_DATA_21`: path to the 1.21 game data directory (on Windows default is %appdata%/VintageStoryData)
+- `VINTAGE_STORY`: path to the 1.21 game install (on Windows default is %appdata%/VintageStory)
+- `VINTAGE_STORY_DATA`: path to the 1.21 game data directory (on Windows default is %appdata%/VintageStoryData)
 - `VINTAGE_STORY_22`: for 1.22 (`Version22` configuration)
 - `VINTAGE_STORY_DATA_22`: for 1.22 (`Version22` configuration)
 - `VS_CONFIGLIB`: path to `configlib.dll`. If not set, will compile with a warning and without configlib support