6 Commits
main ... v2.0.0

12 changed files with 262 additions and 131 deletions

View File

@@ -1,5 +1,5 @@
{ {
"total": 75390, "total": 90094,
"sessions": [ "sessions": [
{ {
"begin": "2026-03-11T23:50:47+01:00", "begin": "2026-03-11T23:50:47+01:00",
@@ -75,6 +75,81 @@
"begin": "2026-03-28T03:48:55+01:00", "begin": "2026-03-28T03:48:55+01:00",
"end": "2026-03-28T04:27:34+01:00", "end": "2026-03-28T04:27:34+01:00",
"duration": 2319 "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
} }
] ]
} }

4
.vscode/tasks.json vendored
View File

@@ -4,9 +4,9 @@
{ {
"label": "check env", "label": "check env",
"type": "shell", "type": "shell",
"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; }", "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",
"windows": { "windows": {
"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 }" "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 } }"
}, },
"problemMatcher": [] "problemMatcher": []
}, },

View File

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

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;

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

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

View File

@@ -24,6 +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 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)
{ {
@@ -83,13 +84,16 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
private string GetActiveMode() 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; return PreviewModes.ON_NEARBY_CONTAINERS;
if (config.HoldKey && !IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE)) if (state.Value.PreviewToggleActive || previewKeyHeld)
return PreviewModes.NONE; return PreviewModes.Normalize(config.Mode);
return PreviewModes.Normalize(config.Mode); return PreviewModes.NONE;
} }
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",

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

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

View File

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

View File

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