3 Commits

Author SHA1 Message Date
97b0d0b0de version 2.0.0 2026-05-23 02:28:09 +02:00
78eeb3dca5 make toggle state persistent 2026-05-23 01:38:09 +02:00
05ae8bb276 hotkeys for toggles / simplify toggling mechanics 2026-05-23 01:13:30 +02:00
8 changed files with 217 additions and 201 deletions

View File

@@ -1,5 +1,5 @@
{ {
"total": 78654, "total": 90094,
"sessions": [ "sessions": [
{ {
"begin": "2026-03-11T23:50:47+01:00", "begin": "2026-03-11T23:50:47+01:00",
@@ -115,6 +115,41 @@
"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
},
{
"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
} }
] ]
} }

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;
} }

View File

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

View File

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

View File

@@ -24,7 +24,7 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
private readonly Config config = config; private readonly Config config = config;
private readonly List<BlockEntity> nearbyContainerEntities = []; private readonly List<BlockEntity> nearbyContainerEntities = [];
private float nearbyScanAccumulator; private float nearbyScanAccumulator;
private Lazy<ChestPreviewModSystem> coreModSystem = new Lazy<ChestPreviewModSystem>(() => api.ModLoader.GetModSystem<ChestPreviewModSystem>()); private readonly Lazy<State> state = new(() => api.ModLoader.GetModSystem<ChestPreviewModSystem>().State);
public void CollectTargets(float deltaTime, List<PreviewTarget> targets) public void CollectTargets(float deltaTime, List<PreviewTarget> targets)
{ {
@@ -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 (state.Value.PreviewNearbyToggleActive || previewNearbyKeyHeld)
return PreviewModes.ON_NEARBY_CONTAINERS; return PreviewModes.ON_NEARBY_CONTAINERS;
return IsPreviewContainersActive() ? PreviewModes.Normalize(config.Mode) : PreviewModes.NONE; if (state.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)

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",
@@ -95,20 +88,6 @@
"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
} }
] ]
} }

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."
} }

View File

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