version 2.0.0

make toggle state persistent
hotkeys for toggles / simplify toggling mechanics
2026-05-23 02:28:09 +02:00 · 2026-05-23 01:38:09 +02:00 · 2026-05-23 01:13:30 +02:00 · 2026-05-22 19:27:05 +02:00 · 2026-05-22 19:25:56 +02:00
8 changed files with 211 additions and 127 deletions
--- a/.timetracker
+++ b/.timetracker
@@ -1,5 +1,5 @@
 {
- "total": 78654,
+ "total": 90094,
 "sessions": [
  {
   "begin": "2026-03-11T23:50:47+01:00",
@@ -115,6 +115,41 @@
   "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
  }
 ]
 }
--- a/ChestPreview/ChestPreview/Configs/Config.cs
+++ b/ChestPreview/ChestPreview/Configs/Config.cs
@@ -4,8 +4,6 @@ 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;
--- a/ChestPreview/ChestPreview/Configs/State.cs
+++ b/ChestPreview/ChestPreview/Configs/State.cs
@@ -0,0 +1,7 @@
+namespace ChestPreview.Configs;
+
+public class State
+{
+    public bool PreviewNearbyToggleActive { get; set; } = false;
+    public bool PreviewToggleActive { get; set; } = false;
+}
--- a/ChestPreview/ChestPreview/Core/ChestPreviewModSystem.cs
+++ b/ChestPreview/ChestPreview/Core/ChestPreviewModSystem.cs
@@ -1,111 +1,157 @@
-using ChestPreview.Configs;
-using ChestPreview.Rendering;
-using System;
-using Vintagestory.API.Client;
-using Vintagestory.API.Common;
-using Vintagestory.API.Config;
-
-namespace ChestPreview.Core;
-
-public class ChestPreviewModSystem : ModSystem
-{
-    internal const string CONFIG_FILENAME = "chestpreview.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";
-
-    private Config config = new();
-    private CardRenderer? cardRenderer;
-    private ConfigLibBridge? configLibBridge;
-    private StorageHoverHudRenderer? storageHoverHudRenderer;
-    private WorldBillboardRenderer? worldBillboardRenderer;
-
-    public override bool ShouldLoad(EnumAppSide forSide) => forSide is EnumAppSide.Client;
-
-    public override void StartClientSide(ICoreClientAPI api)
-    {
-        config = LoadClientConfig(api);
-        RegisterHotkeys(api);
-        if (api.ModLoader.IsModEnabled(ConfigLibBridge.CONFIGLIB_MODID))
-            configLibBridge = ConfigLibBridge.TryCreate(api, config);
-        cardRenderer = new CardRenderer(api, config);
-
-        storageHoverHudRenderer = new StorageHoverHudRenderer(api, config, cardRenderer);
-        api.Event.RegisterRenderer(storageHoverHudRenderer, EnumRenderStage.Ortho, "chestpreview-storage-hover-hud");
-
-        worldBillboardRenderer = new WorldBillboardRenderer(api, config, cardRenderer);
-        api.Event.RegisterRenderer(worldBillboardRenderer, EnumRenderStage.AfterOIT, "chestpreview-world-billboard-preview");
-    }
-
-    public override void Dispose()
-    {
-        configLibBridge?.Dispose();
-        configLibBridge = null;
-
-        if (storageHoverHudRenderer is { } renderer)
-        {
-            renderer.Api.Event.UnregisterRenderer(renderer, EnumRenderStage.Ortho);
-            renderer.Dispose();
-            storageHoverHudRenderer = null;
-        }
-
-        if (worldBillboardRenderer is { } billboardRenderer)
-        {
-            billboardRenderer.Api.Event.UnregisterRenderer(billboardRenderer, EnumRenderStage.AfterOIT);
-            billboardRenderer.Dispose();
-            worldBillboardRenderer = null;
-        }
-
-        cardRenderer?.Dispose();
-        cardRenderer = null;
-    }
-
-    public Config LoadClientConfig(ICoreClientAPI api)
-    {
-        Config config;
-
-        try
-        {
-            config = api.LoadModConfig<Config>(CONFIG_FILENAME) ?? new Config();
-        }
-        catch (Exception ex)
-        {
-            Mod.Logger.Error("Error while loading config.");
-            Mod.Logger.Error(ex);
-            config = new Config();
-        }
-
-        config.Mode = PreviewModes.Normalize(config.Mode);
-        if (config.BillboardColumnsPerBlock <= 0)
-            config.BillboardColumnsPerBlock = 5;
-
-        if (config.ColumnsUnderCursor <= 0)
-            config.ColumnsUnderCursor = 10;
-
-        config.PreviewNearbyRadius = config.PreviewNearbyRadius;
-
-        api.StoreModConfig(config, CONFIG_FILENAME);
-        return config;
-    }
-
-    private static void RegisterHotkeys(ICoreClientAPI api)
-    {
-        api.Input.RegisterHotKey(
-            hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE,
-            name: Lang.Get("chestpreview:hotkey-preview-container"),
-            key: GlKeys.LShift,
-            type: HotkeyType.HelpAndOverlays,
-            altPressed: false,
-            ctrlPressed: false,
-            shiftPressed: false);
-
-        api.Input.RegisterHotKey(
-            hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
-            name: Lang.Get("chestpreview:hotkey-preview-containers-nearby"),
-            key: GlKeys.LShift,
-            type: HotkeyType.HelpAndOverlays,
-            altPressed: false,
-            ctrlPressed: true,
-            shiftPressed: false);
-    }
-}
+using ChestPreview.Configs;
+using ChestPreview.Rendering;
+using System;
+using Vintagestory.API.Client;
+using Vintagestory.API.Common;
+using Vintagestory.API.Config;
+
+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;
+    private ConfigLibBridge? configLibBridge;
+    private StorageHoverHudRenderer? storageHoverHudRenderer;
+    private WorldBillboardRenderer? worldBillboardRenderer;
+
+    public State State { get; } = new();
+
+    public override bool ShouldLoad(EnumAppSide forSide) => forSide is EnumAppSide.Client;
+
+    public override void StartClientSide(ICoreClientAPI api)
+    {
+        config = LoadClientConfig(api);
+        RegisterHotkeys(api);
+        if (api.ModLoader.IsModEnabled(ConfigLibBridge.CONFIGLIB_MODID))
+            configLibBridge = ConfigLibBridge.TryCreate(api, config);
+        cardRenderer = new CardRenderer(api, config);
+
+        storageHoverHudRenderer = new StorageHoverHudRenderer(api, config, cardRenderer);
+        api.Event.RegisterRenderer(storageHoverHudRenderer, EnumRenderStage.Ortho, "chestpreview-storage-hover-hud");
+
+        worldBillboardRenderer = new WorldBillboardRenderer(api, config, cardRenderer);
+        api.Event.RegisterRenderer(worldBillboardRenderer, EnumRenderStage.AfterOIT, "chestpreview-world-billboard-preview");
+
+        api.Input.SetHotKeyHandler(
+            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE,
+            keycomb =>
+            {
+                State.PreviewToggleActive = !State.PreviewToggleActive;
+                api.StoreModConfig(State, STATE_FILENAME);
+                return true;
+            });
+
+        api.Input.SetHotKeyHandler(
+            hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
+            keycomb =>
+            {
+                State.PreviewNearbyToggleActive = !State.PreviewNearbyToggleActive;
+                api.StoreModConfig(State, STATE_FILENAME);
+                return true;
+            });
+    }
+
+    public override void Dispose()
+    {
+        configLibBridge?.Dispose();
+        configLibBridge = null;
+
+        if (storageHoverHudRenderer is { } renderer)
+        {
+            renderer.Api.Event.UnregisterRenderer(renderer, EnumRenderStage.Ortho);
+            renderer.Dispose();
+            storageHoverHudRenderer = null;
+        }
+
+        if (worldBillboardRenderer is { } billboardRenderer)
+        {
+            billboardRenderer.Api.Event.UnregisterRenderer(billboardRenderer, EnumRenderStage.AfterOIT);
+            billboardRenderer.Dispose();
+            worldBillboardRenderer = null;
+        }
+
+        cardRenderer?.Dispose();
+        cardRenderer = null;
+    }
+
+    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)
+        {
+            Mod.Logger.Error("Error while loading config.");
+            Mod.Logger.Error(ex);
+            config = new Config();
+        }
+
+        config.Mode = PreviewModes.Normalize(config.Mode);
+        if (config.BillboardColumnsPerBlock <= 0)
+            config.BillboardColumnsPerBlock = 5;
+
+        if (config.ColumnsUnderCursor <= 0)
+            config.ColumnsUnderCursor = 10;
+
+        config.PreviewNearbyRadius = config.PreviewNearbyRadius;
+
+        api.StoreModConfig(config, CONFIG_FILENAME);
+        api.StoreModConfig(State, STATE_FILENAME);
+        return config;
+    }
+
+    private static void RegisterHotkeys(ICoreClientAPI api)
+    {
+        api.Input.RegisterHotKey(
+            hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE,
+            name: Lang.Get("chestpreview:hotkey-preview-container"),
+            key: GlKeys.LShift,
+            type: HotkeyType.HelpAndOverlays,
+            altPressed: false,
+            ctrlPressed: false,
+            shiftPressed: false);
+
+        api.Input.RegisterHotKey(
+            hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
+            name: Lang.Get("chestpreview:hotkey-preview-containers-nearby"),
+            key: GlKeys.LShift,
+            type: HotkeyType.HelpAndOverlays,
+            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);
+    }
+}
--- a/ChestPreview/ChestPreview/PreviewTargetProvider.cs
+++ b/ChestPreview/ChestPreview/PreviewTargetProvider.cs
@@ -24,6 +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);

    public void CollectTargets(float deltaTime, List<PreviewTarget> targets)
    {
@@ -83,13 +84,16 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)

    private string GetActiveMode()
    {
-        if (IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE))
+        var previewKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE);
+        var previewNearbyKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE);
+
+        if (state.Value.PreviewNearbyToggleActive || previewNearbyKeyHeld)
            return PreviewModes.ON_NEARBY_CONTAINERS;

-        if (config.HoldKey && !IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE))
-            return PreviewModes.NONE;
+        if (state.Value.PreviewToggleActive || previewKeyHeld)
+            return PreviewModes.Normalize(config.Mode);

-        return PreviewModes.Normalize(config.Mode);
+        return PreviewModes.NONE;
    }

    private bool IsHotkeyHeld(string hotkeyCode)
--- a/ChestPreview/ChestPreview/assets/chestpreview/config/configlib-patches.json
+++ b/ChestPreview/ChestPreview/assets/chestpreview/config/configlib-patches.json
@@ -20,13 +20,6 @@
            ],
            "clientSide": true
        },
-        {
-            "code": "HoldKey",
-            "comment": "config-desc-HoldKey",
-            "type": "boolean",
-            "default": true,
-            "clientSide": true
-        },
        {
            "code": "BillboardIgnoreFront",
            "comment": "config-desc-BillboardIgnoreFront",
--- a/ChestPreview/ChestPreview/assets/chestpreview/lang/en.json
+++ b/ChestPreview/ChestPreview/assets/chestpreview/lang/en.json
@@ -1,8 +1,9 @@
 {
    "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.",
--- a/ChestPreview/ChestPreview/modinfo.json
+++ b/ChestPreview/ChestPreview/modinfo.json
@@ -7,7 +7,7 @@
        "OrekiWoof"
    ],
    "description": "see containers' contents without having to open them",
-    "version": "1.2.0",
+    "version": "2.0.0",
    "dependencies": {
        "game": "1.21.0"
    },
Author	SHA1	Message	Date
OrekiWoof	97b0d0b0de	version 2.0.0	2026-05-23 02:28:09 +02:00
OrekiWoof	78eeb3dca5	make toggle state persistent	2026-05-23 01:38:09 +02:00
OrekiWoof	05ae8bb276	hotkeys for toggles / simplify toggling mechanics	2026-05-23 01:13:30 +02:00
OrekiWoof	fb80e2ddbf	Merge pull request 'Add toggle options for preview and preview nearby' (#4 ) from Spoonail/ChestPreview:option-toggle-preview into main	2026-05-22 19:27:05 +02:00
Mononospace	e835998390	Add toggle options for preview and preview nearby	2026-05-22 19:25:56 +02:00