OrekiWoof/ChestPreview
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

hotkeys for toggles / simplify toggling mechanics

Browse Source
This commit is contained in:
OrekiWoof
2026-05-23 01:13:30 +02:00
parent fb80e2ddbf
commit 05ae8bb276
6 changed files with 186 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
.timetracker
View File

@@ -1,5 +1,5 @@
{ {
"total": 78654, "total": 85508,
"sessions": [ "sessions": [
{ {
"begin": "2026-03-11T23:50:47+01:00", "begin": "2026-03-11T23:50:47+01:00",
@@ -115,6 +115,26 @@
"begin": "2026-05-22T19:13:27+02:00", "begin": "2026-05-22T19:13:27+02:00",
"end": "2026-05-22T19:21:36+02:00", "end": "2026-05-22T19:21:36+02:00",
"duration": 489 "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
} }
] ]
} }

6
ChestPreview/ChestPreview/Configs/Config.cs
View File

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

282
ChestPreview/ChestPreview/Core/ChestPreviewModSystem.cs
View File

@@ -1,132 +1,150 @@
using ChestPreview.Configs; using ChestPreview.Configs;
using ChestPreview.Rendering; using ChestPreview.Rendering;
using System; using System;
using Vintagestory.API.Client; using Vintagestory.API.Client;
using Vintagestory.API.Common; using Vintagestory.API.Common;
using Vintagestory.API.Config; using Vintagestory.API.Config;
namespace ChestPreview.Core; namespace ChestPreview.Core;
public class ChestPreviewModSystem : ModSystem public class ChestPreviewModSystem : ModSystem
{ {
internal const string CONFIG_FILENAME = "chestpreview.json"; internal const string CONFIG_FILENAME = "chestpreview.json";
internal const string CONFIGLIB_DOMAIN = "chestpreview"; internal const string CONFIGLIB_DOMAIN = "chestpreview";
internal const string PREVIEW_CONTAINERS_HOTKEY_CODE = "chestpreview-preview-containers"; 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 PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE = "chestpreview-preview-containers-nearby";
internal const string TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE = "chestpreview-preview-containers-toggle";
private Config config = new(); internal const string TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE = "chestpreview-preview-containers-nearby-toggle";
private CardRenderer? cardRenderer;
private ConfigLibBridge? configLibBridge; private Config config = new();
private StorageHoverHudRenderer? storageHoverHudRenderer; private CardRenderer? cardRenderer;
private WorldBillboardRenderer? worldBillboardRenderer; private ConfigLibBridge? configLibBridge;
private StorageHoverHudRenderer? storageHoverHudRenderer;
public bool PreviewNearbyToggleState { get; private set; } = false; private WorldBillboardRenderer? worldBillboardRenderer;
public bool PreviewToggleState { get; private set; } = false;
public bool PreviewNearbyToggleActive { get; private set; } = false;
public override bool ShouldLoad(EnumAppSide forSide) => forSide is EnumAppSide.Client; public bool PreviewToggleActive { get; private set; } = false;
public override void StartClientSide(ICoreClientAPI api) public override bool ShouldLoad(EnumAppSide forSide) => forSide is EnumAppSide.Client;
{
config = LoadClientConfig(api); public override void StartClientSide(ICoreClientAPI api)
RegisterHotkeys(api); {
if (api.ModLoader.IsModEnabled(ConfigLibBridge.CONFIGLIB_MODID)) config = LoadClientConfig(api);
configLibBridge = ConfigLibBridge.TryCreate(api, config); RegisterHotkeys(api);
cardRenderer = new CardRenderer(api, config); if (api.ModLoader.IsModEnabled(ConfigLibBridge.CONFIGLIB_MODID))
configLibBridge = ConfigLibBridge.TryCreate(api, config);
storageHoverHudRenderer = new StorageHoverHudRenderer(api, config, cardRenderer); cardRenderer = new CardRenderer(api, config);
api.Event.RegisterRenderer(storageHoverHudRenderer, EnumRenderStage.Ortho, "chestpreview-storage-hover-hud");
storageHoverHudRenderer = new StorageHoverHudRenderer(api, config, cardRenderer);
worldBillboardRenderer = new WorldBillboardRenderer(api, config, cardRenderer); api.Event.RegisterRenderer(storageHoverHudRenderer, EnumRenderStage.Ortho, "chestpreview-storage-hover-hud");
api.Event.RegisterRenderer(worldBillboardRenderer, EnumRenderStage.AfterOIT, "chestpreview-world-billboard-preview");
worldBillboardRenderer = new WorldBillboardRenderer(api, config, cardRenderer);
api.Input.SetHotKeyHandler( api.Event.RegisterRenderer(worldBillboardRenderer, EnumRenderStage.AfterOIT, "chestpreview-world-billboard-preview");
hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE,
keycomb => api.Input.SetHotKeyHandler(
{ hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_HOTKEY_CODE,
if (!config.TogglePreview) return false; keycomb =>
this.PreviewToggleState = !this.PreviewToggleState; {
return true; PreviewToggleActive = !PreviewToggleActive;
}); return true;
});
api.Input.SetHotKeyHandler(
hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE, api.Input.SetHotKeyHandler(
keycomb => hotkeyCode: TOGGLE_PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
{ keycomb =>
if (!config.TogglePreviewNearby) return false; {
this.PreviewNearbyToggleState = !this.PreviewNearbyToggleState; PreviewNearbyToggleActive = !PreviewNearbyToggleActive;
return true; return true;
}); });
} }
public override void Dispose() public override void Dispose()
{ {
configLibBridge?.Dispose(); configLibBridge?.Dispose();
configLibBridge = null; configLibBridge = null;
if (storageHoverHudRenderer is { } renderer) if (storageHoverHudRenderer is { } renderer)
{ {
renderer.Api.Event.UnregisterRenderer(renderer, EnumRenderStage.Ortho); renderer.Api.Event.UnregisterRenderer(renderer, EnumRenderStage.Ortho);
renderer.Dispose(); renderer.Dispose();
storageHoverHudRenderer = null; storageHoverHudRenderer = null;
} }
if (worldBillboardRenderer is { } billboardRenderer) if (worldBillboardRenderer is { } billboardRenderer)
{ {
billboardRenderer.Api.Event.UnregisterRenderer(billboardRenderer, EnumRenderStage.AfterOIT); billboardRenderer.Api.Event.UnregisterRenderer(billboardRenderer, EnumRenderStage.AfterOIT);
billboardRenderer.Dispose(); billboardRenderer.Dispose();
worldBillboardRenderer = null; worldBillboardRenderer = null;
} }
cardRenderer?.Dispose(); cardRenderer?.Dispose();
cardRenderer = null; cardRenderer = null;
} }
public Config LoadClientConfig(ICoreClientAPI api) public Config LoadClientConfig(ICoreClientAPI api)
{ {
Config config; Config config;
try try
{ {
config = api.LoadModConfig<Config>(CONFIG_FILENAME) ?? new Config(); config = api.LoadModConfig<Config>(CONFIG_FILENAME) ?? new Config();
} }
catch (Exception ex) catch (Exception ex)
{ {
Mod.Logger.Error("Error while loading config."); Mod.Logger.Error("Error while loading config.");
Mod.Logger.Error(ex); Mod.Logger.Error(ex);
config = new Config(); config = new Config();
} }
config.Mode = PreviewModes.Normalize(config.Mode); config.Mode = PreviewModes.Normalize(config.Mode);
if (config.BillboardColumnsPerBlock <= 0) if (config.BillboardColumnsPerBlock <= 0)
config.BillboardColumnsPerBlock = 5; config.BillboardColumnsPerBlock = 5;
if (config.ColumnsUnderCursor <= 0) if (config.ColumnsUnderCursor <= 0)
config.ColumnsUnderCursor = 10; config.ColumnsUnderCursor = 10;
config.PreviewNearbyRadius = config.PreviewNearbyRadius; config.PreviewNearbyRadius = config.PreviewNearbyRadius;
api.StoreModConfig(config, CONFIG_FILENAME); api.StoreModConfig(config, CONFIG_FILENAME);
return config; return config;
} }
private static void RegisterHotkeys(ICoreClientAPI api) private static void RegisterHotkeys(ICoreClientAPI api)
{ {
api.Input.RegisterHotKey( api.Input.RegisterHotKey(
hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE, hotkeyCode: PREVIEW_CONTAINERS_HOTKEY_CODE,
name: Lang.Get("chestpreview:hotkey-preview-container"), name: Lang.Get("chestpreview:hotkey-preview-container"),
key: GlKeys.LShift, key: GlKeys.LShift,
type: HotkeyType.HelpAndOverlays, type: HotkeyType.HelpAndOverlays,
altPressed: false, altPressed: false,
ctrlPressed: false, ctrlPressed: false,
shiftPressed: false); shiftPressed: false);
api.Input.RegisterHotKey( api.Input.RegisterHotKey(
hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE, hotkeyCode: PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE,
name: Lang.Get("chestpreview:hotkey-preview-containers-nearby"), name: Lang.Get("chestpreview:hotkey-preview-containers-nearby"),
key: GlKeys.LShift, key: GlKeys.LShift,
type: HotkeyType.HelpAndOverlays, type: HotkeyType.HelpAndOverlays,
altPressed: false, altPressed: false,
ctrlPressed: true, ctrlPressed: true,
shiftPressed: false); 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);
}
}

37
ChestPreview/ChestPreview/PreviewTargetProvider.cs
View File

@@ -84,39 +84,16 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
private string GetActiveMode() private string GetActiveMode()
{ {
if (IsPreviewContainersNearbyActive()) var previewKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE);
var previewNearbyKeyHeld = IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE);
if (coreModSystem.Value.PreviewNearbyToggleActive || previewNearbyKeyHeld)
return PreviewModes.ON_NEARBY_CONTAINERS; return PreviewModes.ON_NEARBY_CONTAINERS;
return IsPreviewContainersActive() ? PreviewModes.Normalize(config.Mode) : PreviewModes.NONE; if (coreModSystem.Value.PreviewToggleActive || previewKeyHeld)
} return PreviewModes.Normalize(config.Mode);
private bool IsPreviewContainersNearbyActive() return PreviewModes.NONE;
{
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) private bool IsHotkeyHeld(string hotkeyCode)

31
ChestPreview/ChestPreview/assets/chestpreview/config/configlib-patches.json
View File

@@ -20,13 +20,6 @@
], ],
"clientSide": true "clientSide": true
}, },
{
"code": "HoldKey",
"comment": "config-desc-HoldKey",
"type": "boolean",
"default": true,
"clientSide": true
},
{ {
"code": "BillboardIgnoreFront", "code": "BillboardIgnoreFront",
"comment": "config-desc-BillboardIgnoreFront", "comment": "config-desc-BillboardIgnoreFront",
@@ -90,25 +83,11 @@
"clientSide": true "clientSide": true
}, },
{ {
"code": "GroundStorageOnlyContainers", "code": "GroundStorageOnlyContainers",
"comment": "config-desc-GroundStorageOnlyContainers", "comment": "config-desc-GroundStorageOnlyContainers",
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"clientSide": 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
} }
] ]
} }

7
ChestPreview/ChestPreview/assets/chestpreview/lang/en.json
View File

@@ -1,8 +1,9 @@
{ {
"hotkey-preview-container": "Preview container", "hotkey-preview-container": "Preview container",
"hotkey-preview-containers-nearby": "Preview containers nearby", "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-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-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-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.", "config-desc-ColumnsUnderCursor": "Columns in the UnderCursor mode.",
@@ -10,7 +11,5 @@
"config-desc-WhitelistedContainersOnly": "If true, only container codes in WhitelistedContainers are handled.", "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-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-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."
} }