16 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
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
8bf4735da7 update envs 2026-05-22 19:25:16 +02:00
79c6ed928a update version to 1.2.0 2026-03-28 04:51:11 +01:00
b912a664e7 Merge pull request 'config option for ignoring fronts of containers' (#2) from side-view-all into main 2026-03-28 04:50:43 +01:00
b23345b273 config option for ignoring fronts of containers 2026-03-28 04:49:19 +01:00
1e20533f10 add MIT license 2026-03-16 15:17:30 +01:00
2ad99a9d3b VS_CONFIGLIB for CakeBuild 2026-03-16 00:37:10 +01:00
074b34dd24 crash prevention when failing to GetContents in CardRenderer 2026-03-16 00:36:49 +01:00
d7c541fcc5 front_face_offset 0.01 -> 0.05 2026-03-16 00:01:10 +01:00
16b901fab7 fix rendering on the opposite side when reading "side" 2026-03-15 23:55:21 +01:00
5389901c82 support for Forge 2026-03-15 23:53:23 +01:00
27cfbcaa10 support for groundstorable containers and bloomery 2026-03-15 23:24:44 +01:00
17 changed files with 1660 additions and 1280 deletions

View File

@@ -1,5 +1,5 @@
{
"total": 66247,
"total": 90094,
"sessions": [
{
"begin": "2026-03-11T23:50:47+01:00",
@@ -65,6 +65,91 @@
"begin": "2026-03-15T20:33:08+01:00",
"end": "2026-03-15T20:53:09+01:00",
"duration": 1201
},
{
"begin": "2026-03-15T21:00:39+01:00",
"end": "2026-03-15T23:04:35+01:00",
"duration": 7435
},
{
"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
}
]
}

4
.vscode/tasks.json vendored
View File

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

View File

@@ -6,6 +6,8 @@
<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>

View File

@@ -1,20 +1,22 @@
namespace ChestPreview.Configs;
public sealed class Config
{
public string Mode { get; set; } = PreviewModes.UNDER_CURSOR;
public bool HoldKey { get; set; } = true;
public int BillboardColumnsPerBlock { get; set; } = 4;
public int ColumnsUnderCursor { get; set; } = 10;
public int PreviewNearbyRadius { get; set; } = 8;
public bool WhitelistedContainersOnly { get; set; } = true;
public string WhitelistedContainers { get; set; } = "barrel, crate, chest-*, trunk-*, storagevessel-*, stationarybasket-*, labeledchest-*";
public string BlacklistedContainers { get; set; } = "";
namespace ChestPreview.Configs;
public sealed class Config
{
public string Mode { get; set; } = PreviewModes.UNDER_CURSOR;
public bool BillboardIgnoreFront { get; set; } = false;
public int BillboardColumnsPerBlock { get; set; } = 4;
public int ColumnsUnderCursor { get; set; } = 10;
public int PreviewNearbyRadius { get; set; } = 8;
public bool WhitelistedContainersOnly { get; set; } = true;
public string WhitelistedContainers { get; set; } = "barrel, crate, chest-*, trunk-*, storagevessel-*, stationarybasket-*, labeledchest-*, groundstorage";
public string BlacklistedContainers { get; set; } = "";
public bool GroundStorageOnlyContainers { get; set; } = true;
}

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

View File

@@ -1,284 +1,335 @@
using ChestPreview.Configs;
using ChestPreview.Core;
using ChestPreview.Models;
using ChestPreview.Utils;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using System.Text.RegularExpressions;
using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.MathTools;
using Vintagestory.API.Util;
namespace ChestPreview;
internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config) : IDisposable
{
private const float nearby_scan_interval_seconds = 0.1f;
private static readonly Regex list_separator_regex = ListSeparatorRegex();
private readonly ICoreClientAPI api = api;
private readonly Config config = config;
private readonly List<BlockEntity> nearbyContainerEntities = [];
private float nearbyScanAccumulator;
public void CollectTargets(float deltaTime, List<PreviewTarget> targets)
{
string mode = GetActiveMode();
if (mode == PreviewModes.NONE)
return;
if (mode == PreviewModes.ON_NEARBY_CONTAINERS)
{
CollectNearbyTargets(deltaTime, targets);
return;
}
if (!TryGetHoveredContainer(out Block hoveredBlock, out BlockEntity hoveredBlockEntity))
return;
if (!CanAccessContainer(hoveredBlockEntity))
return;
if (!IsContainerAllowed(hoveredBlock))
return;
targets.Add(new PreviewTarget(hoveredBlock, hoveredBlockEntity, mode, GetContainerAnchor(hoveredBlock, hoveredBlockEntity.Pos)));
}
public void Dispose()
{
nearbyContainerEntities.Clear();
}
private void CollectNearbyTargets(float deltaTime, List<PreviewTarget> targets)
{
nearbyScanAccumulator += deltaTime;
bool shouldRefresh = nearbyContainerEntities.Count == 0 || nearbyScanAccumulator >= nearby_scan_interval_seconds;
if (shouldRefresh)
{
RefreshNearbyContainers();
nearbyScanAccumulator = 0f;
}
foreach (BlockEntity blockEntity in nearbyContainerEntities)
{
Block block = api.World.BlockAccessor.GetBlock(blockEntity.Pos);
if (block.Id == 0)
continue;
if (!CanAccessContainer(blockEntity))
continue;
if (!IsContainerAllowed(block))
continue;
targets.Add(new PreviewTarget(block, blockEntity, PreviewModes.ON_NEARBY_CONTAINERS, GetContainerAnchor(block, blockEntity.Pos)));
}
}
private string GetActiveMode()
{
if (IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_NEARBY_HOTKEY_CODE))
return PreviewModes.ON_NEARBY_CONTAINERS;
if (config.HoldKey && !IsHotkeyHeld(ChestPreviewModSystem.PREVIEW_CONTAINERS_HOTKEY_CODE))
return PreviewModes.NONE;
return PreviewModes.Normalize(config.Mode);
}
private bool IsHotkeyHeld(string hotkeyCode)
{
HotKey? hotKey = api.Input.GetHotKeyByCode(hotkeyCode);
if (hotKey?.CurrentMapping == null)
return false;
KeyCombination mapping = hotKey.CurrentMapping;
if (!IsKeyHeld(mapping.KeyCode))
return false;
if (mapping.SecondKeyCode.HasValue && !IsKeyHeld(mapping.SecondKeyCode.Value))
return false;
EntityControls? controls = api.World.Player?.Entity?.Controls;
if (mapping.Ctrl && controls?.CtrlKey != true)
return false;
if (mapping.Shift && controls?.ShiftKey != true)
return false;
return !mapping.Alt || IsAltHeld();
}
private bool IsKeyHeld(int keyCode)
{
bool[] keyStates = api.Input.KeyboardKeyStateRaw;
return keyCode >= 0 && keyCode < keyStates.Length && keyStates[keyCode];
}
private bool IsAltHeld()
{
return IsKeyHeld((int)GlKeys.AltLeft) || IsKeyHeld((int)GlKeys.AltRight);
}
private bool TryGetHoveredContainer(out Block block, out BlockEntity blockEntity)
{
block = null!;
blockEntity = null!;
BlockSelection? currentBlockSelection = api.World.Player?.CurrentBlockSelection;
if (currentBlockSelection == null)
return false;
BlockEntity? currentBlockEntity = api.World.BlockAccessor.GetBlockEntity(currentBlockSelection.Position);
if (currentBlockEntity is IBlockEntityContainer)
{
block = currentBlockSelection.Block;
blockEntity = currentBlockEntity;
return true;
}
if (!TryResolveMultiblockControllerContainer(currentBlockSelection, out Block controllerBlock, out BlockEntity controllerBlockEntity))
return false;
block = controllerBlock;
blockEntity = controllerBlockEntity;
return true;
}
private bool TryResolveMultiblockControllerContainer(BlockSelection blockSelection, out Block controllerBlock, out BlockEntity controllerBlockEntity)
{
controllerBlock = null!;
controllerBlockEntity = null!;
if (blockSelection.Block is not IMultiblockOffset multiblockOffset)
return false;
BlockPos controllerPos = multiblockOffset.GetControlBlockPos(blockSelection.Position);
BlockEntity? blockEntity = api.World.BlockAccessor.GetBlockEntity(controllerPos);
if (blockEntity is not IBlockEntityContainer)
return false;
controllerBlock = api.World.BlockAccessor.GetBlock(controllerPos);
if (controllerBlock.Id == 0)
return false;
controllerBlockEntity = blockEntity;
return true;
}
private void RefreshNearbyContainers()
{
nearbyContainerEntities.Clear();
EntityPlayer? playerEntity = api.World.Player?.Entity;
if (playerEntity?.CameraPos == null)
return;
float nearbyRadius = config.PreviewNearbyRadius;
float nearbyRadiusSquared = nearbyRadius * nearbyRadius;
Vec3d nearbyRadiusOffset = new(nearbyRadius, nearbyRadius, nearbyRadius);
BlockPos minPos = (playerEntity.CameraPos - nearbyRadiusOffset).AsBlockPos;
BlockPos maxPos = (playerEntity.CameraPos + nearbyRadiusOffset + new Vec3d(1d, 1d, 1d)).AsBlockPos;
api.World.BlockAccessor.WalkBlocks(minPos, maxPos, (block, x, y, z) =>
{
double horizontalDx = x + 0.5d - playerEntity.CameraPos.X;
double horizontalDz = z + 0.5d - playerEntity.CameraPos.Z;
if (horizontalDx * horizontalDx + horizontalDz * horizontalDz > nearbyRadiusSquared)
return;
if (Math.Abs(y + 0.5d - playerEntity.CameraPos.Y) > nearbyRadius)
return;
BlockEntity? blockEntity = api.World.BlockAccessor.GetBlockEntity(new BlockPos(x, y, z));
if (blockEntity is not IBlockEntityContainer)
return;
if (block.Id == 0)
return;
nearbyContainerEntities.Add(blockEntity);
});
}
private Vec3d GetContainerAnchor(Block block, BlockPos blockPos)
{
GetContainerBounds(block, blockPos, out Vector3 min, out Vector3 max);
Vector3 anchor = blockPos.ToVector3() + new Vector3((min.X + max.X) * 0.5f, max.Y + 0.1f, (min.Z + max.Z) * 0.5f);
return anchor.ToVec3d();
}
private void GetContainerBounds(Block block, BlockPos blockPos, out Vector3 min, out Vector3 max)
{
Cuboidf[]? selectionBoxes = block.GetSelectionBoxes(api.World.BlockAccessor, blockPos);
min = new Vector3(0f, 0f, 0f);
max = new Vector3(1f, 1f, 1f);
if (selectionBoxes is not { Length: > 0 })
return;
foreach (Cuboidf selectionBox in selectionBoxes)
{
min = Vector3.Min(min, selectionBox.Start.ToVector3());
max = Vector3.Max(max, selectionBox.End.ToVector3());
}
}
private bool CanAccessContainer(BlockEntity blockEntity)
{
if (blockEntity is not IBlockEntityContainer container || container.Inventory is not InventoryBase inventory)
return false;
IPlayer? player = api.World.Player;
EntityPlayer? playerEntity = player?.Entity;
if (player == null || playerEntity == null)
return false;
return inventory.CanPlayerAccess(player, playerEntity.GetPos());
}
private bool IsContainerAllowed(Block block)
{
string? code = block.Code?.Path;
if (string.IsNullOrWhiteSpace(code))
return true;
HashSet<string> blacklist = ParseContainerCodes(config.BlacklistedContainers);
if (blacklist.Any(x => WildcardUtil.Match(x, code)))
return false;
if (!config.WhitelistedContainersOnly)
return true;
HashSet<string> whitelist = ParseContainerCodes(config.WhitelistedContainers);
return whitelist.Any(x => WildcardUtil.Match(x, code));
}
private static HashSet<string> ParseContainerCodes(string rawList)
{
if (string.IsNullOrWhiteSpace(rawList))
return [];
string[] entries = list_separator_regex.Split(rawList.Trim());
HashSet<string> result = new(StringComparer.OrdinalIgnoreCase);
foreach (string entry in entries)
{
if (!string.IsNullOrWhiteSpace(entry))
result.Add(entry);
}
return result;
}
[GeneratedRegex("[,;\\s]+", RegexOptions.Compiled)]
private static partial Regex ListSeparatorRegex();
using ChestPreview.Configs;
using ChestPreview.Core;
using ChestPreview.Models;
using ChestPreview.Utils;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using System.Text.RegularExpressions;
using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.MathTools;
using Vintagestory.API.Util;
using Vintagestory.GameContent;
namespace ChestPreview;
internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config) : IDisposable
{
private const float nearby_scan_interval_seconds = 0.1f;
private static readonly Regex list_separator_regex = ListSeparatorRegex();
private readonly ICoreClientAPI api = api;
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)
{
string mode = GetActiveMode();
if (mode == PreviewModes.NONE)
return;
if (mode == PreviewModes.ON_NEARBY_CONTAINERS)
{
CollectNearbyTargets(deltaTime, targets);
return;
}
if (!TryGetHoveredContainer(out Block hoveredBlock, out BlockEntity hoveredBlockEntity))
return;
if (!CanAccessContainer(hoveredBlock, hoveredBlockEntity))
return;
if (!IsContainerAllowed(hoveredBlock))
return;
targets.Add(new PreviewTarget(hoveredBlock, hoveredBlockEntity, mode, GetContainerAnchor(hoveredBlock, hoveredBlockEntity.Pos)));
}
public void Dispose()
{
nearbyContainerEntities.Clear();
}
private void CollectNearbyTargets(float deltaTime, List<PreviewTarget> targets)
{
nearbyScanAccumulator += deltaTime;
bool shouldRefresh = nearbyContainerEntities.Count == 0 || nearbyScanAccumulator >= nearby_scan_interval_seconds;
if (shouldRefresh)
{
RefreshNearbyContainers();
nearbyScanAccumulator = 0f;
}
foreach (BlockEntity blockEntity in nearbyContainerEntities)
{
Block block = api.World.BlockAccessor.GetBlock(blockEntity.Pos);
if (block.Id == 0)
continue;
if (!CanAccessContainer(block, blockEntity))
continue;
if (!IsContainerAllowed(block))
continue;
targets.Add(new PreviewTarget(block, blockEntity, PreviewModes.ON_NEARBY_CONTAINERS, GetContainerAnchor(block, blockEntity.Pos)));
}
}
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)
return PreviewModes.ON_NEARBY_CONTAINERS;
if (state.Value.PreviewToggleActive || previewKeyHeld)
return PreviewModes.Normalize(config.Mode);
return PreviewModes.NONE;
}
private bool IsHotkeyHeld(string hotkeyCode)
{
HotKey? hotKey = api.Input.GetHotKeyByCode(hotkeyCode);
if (hotKey?.CurrentMapping == null)
return false;
KeyCombination mapping = hotKey.CurrentMapping;
if (!IsKeyHeld(mapping.KeyCode))
return false;
if (mapping.SecondKeyCode.HasValue && !IsKeyHeld(mapping.SecondKeyCode.Value))
return false;
EntityControls? controls = api.World.Player?.Entity?.Controls;
if (mapping.Ctrl && controls?.CtrlKey != true)
return false;
if (mapping.Shift && controls?.ShiftKey != true)
return false;
return !mapping.Alt || IsAltHeld();
}
private bool IsKeyHeld(int keyCode)
{
bool[] keyStates = api.Input.KeyboardKeyStateRaw;
return keyCode >= 0 && keyCode < keyStates.Length && keyStates[keyCode];
}
private bool IsAltHeld()
{
return IsKeyHeld((int)GlKeys.AltLeft) || IsKeyHeld((int)GlKeys.AltRight);
}
private bool TryGetHoveredContainer(out Block block, out BlockEntity blockEntity)
{
block = null!;
blockEntity = null!;
BlockSelection? currentBlockSelection = api.World.Player?.CurrentBlockSelection;
if (currentBlockSelection == null)
return false;
BlockPos hoveredPos = currentBlockSelection.Position;
BlockEntity? currentBlockEntity = api.World.BlockAccessor.GetBlockEntity(hoveredPos);
if (HasPreviewableStorage(currentBlockSelection.Block, hoveredPos, currentBlockEntity))
{
block = currentBlockSelection.Block;
if (currentBlockEntity == null)
return false;
blockEntity = currentBlockEntity;
return true;
}
if (!TryResolveMultiblockControllerContainer(currentBlockSelection, out Block controllerBlock, out BlockEntity controllerBlockEntity))
return false;
block = controllerBlock;
blockEntity = controllerBlockEntity;
return true;
}
private bool TryResolveMultiblockControllerContainer(BlockSelection blockSelection, out Block controllerBlock, out BlockEntity controllerBlockEntity)
{
controllerBlock = null!;
controllerBlockEntity = null!;
if (blockSelection.Block is not IMultiblockOffset multiblockOffset)
return false;
BlockPos controllerPos = multiblockOffset.GetControlBlockPos(blockSelection.Position);
controllerBlock = api.World.BlockAccessor.GetBlock(controllerPos);
if (controllerBlock.Id == 0)
return false;
BlockEntity? blockEntity = api.World.BlockAccessor.GetBlockEntity(controllerPos);
if (!HasPreviewableStorage(controllerBlock, controllerPos, blockEntity))
return false;
if (blockEntity == null)
return false;
controllerBlockEntity = blockEntity;
return true;
}
private void RefreshNearbyContainers()
{
nearbyContainerEntities.Clear();
EntityPlayer? playerEntity = api.World.Player?.Entity;
if (playerEntity?.CameraPos == null)
return;
float nearbyRadius = config.PreviewNearbyRadius;
float nearbyRadiusSquared = nearbyRadius * nearbyRadius;
Vec3d nearbyRadiusOffset = new(nearbyRadius, nearbyRadius, nearbyRadius);
BlockPos minPos = (playerEntity.CameraPos - nearbyRadiusOffset).AsBlockPos;
BlockPos maxPos = (playerEntity.CameraPos + nearbyRadiusOffset + new Vec3d(1d, 1d, 1d)).AsBlockPos;
api.World.BlockAccessor.WalkBlocks(minPos, maxPos, (block, x, y, z) =>
{
double horizontalDx = x + 0.5d - playerEntity.CameraPos.X;
double horizontalDz = z + 0.5d - playerEntity.CameraPos.Z;
if (horizontalDx * horizontalDx + horizontalDz * horizontalDz > nearbyRadiusSquared)
return;
if (Math.Abs(y + 0.5d - playerEntity.CameraPos.Y) > nearbyRadius)
return;
if (block.Id == 0)
return;
BlockPos blockPos = new(x, y, z);
BlockEntity? blockEntity = api.World.BlockAccessor.GetBlockEntity(blockPos);
if (!HasPreviewableStorage(block, blockPos, blockEntity))
return;
if (blockEntity == null)
return;
nearbyContainerEntities.Add(blockEntity);
});
}
private Vec3d GetContainerAnchor(Block block, BlockPos blockPos)
{
GetContainerBounds(block, blockPos, out Vector3 min, out Vector3 max);
Vector3 anchor = blockPos.ToVector3() + new Vector3((min.X + max.X) * 0.5f, max.Y + 0.1f, (min.Z + max.Z) * 0.5f);
return anchor.ToVec3d();
}
private void GetContainerBounds(Block block, BlockPos blockPos, out Vector3 min, out Vector3 max)
{
Cuboidf[]? selectionBoxes = block.GetSelectionBoxes(api.World.BlockAccessor, blockPos);
min = new Vector3(0f, 0f, 0f);
max = new Vector3(1f, 1f, 1f);
if (selectionBoxes is not { Length: > 0 })
return;
foreach (Cuboidf selectionBox in selectionBoxes)
{
min = Vector3.Min(min, selectionBox.Start.ToVector3());
max = Vector3.Max(max, selectionBox.End.ToVector3());
}
}
private bool CanAccessContainer(Block block, BlockEntity blockEntity)
{
if (config.GroundStorageOnlyContainers && blockEntity is BlockEntityGroundStorage && !HasHeldBagInGroundStorage(blockEntity))
return false;
BlockPos blockPos = blockEntity.Pos;
if (block.GetInterface<IBlockEntityContainer>(api.World, blockPos) is { } container && container.Inventory is InventoryBase inventory)
{
IPlayer? player = api.World.Player;
EntityPlayer? playerEntity = player?.Entity;
if (player == null || playerEntity == null)
return false;
return inventory.CanPlayerAccess(player, playerEntity.GetPos());
}
if (blockEntity is BlockEntityBloomery or BlockEntityForge)
return true;
return HasHeldBagInGroundStorage(blockEntity);
}
private bool HasPreviewableStorage(Block block, BlockPos blockPos, BlockEntity? blockEntity)
{
if (config.GroundStorageOnlyContainers && blockEntity is BlockEntityGroundStorage)
return HasHeldBagInGroundStorage(blockEntity);
return block.GetInterface<IBlockEntityContainer>(api.World, blockPos) != null || HasHeldBagInGroundStorage(blockEntity) || (blockEntity is BlockEntityBloomery or BlockEntityForge);
}
private static bool HasHeldBagInGroundStorage(BlockEntity? blockEntity)
{
if (blockEntity is not BlockEntityGroundStorage groundStorage)
return false;
foreach (ItemSlot? slot in groundStorage.Inventory)
{
if (slot?.Itemstack?.Collectible is not { } collectible)
continue;
IHeldBag? heldBag = collectible.GetCollectibleInterface<IHeldBag>();
if (heldBag != null)
return true;
}
return false;
}
private bool IsContainerAllowed(Block block)
{
string? code = block.Code?.Path;
if (string.IsNullOrWhiteSpace(code))
return true;
HashSet<string> blacklist = ParseContainerCodes(config.BlacklistedContainers);
if (blacklist.Any(x => WildcardUtil.Match(x, code)))
return false;
if (!config.WhitelistedContainersOnly)
return true;
HashSet<string> whitelist = ParseContainerCodes(config.WhitelistedContainers);
return whitelist.Any(x => WildcardUtil.Match(x, code));
}
private static HashSet<string> ParseContainerCodes(string rawList)
{
if (string.IsNullOrWhiteSpace(rawList))
return [];
string[] entries = list_separator_regex.Split(rawList.Trim());
HashSet<string> result = new(StringComparer.OrdinalIgnoreCase);
foreach (string entry in entries)
{
if (!string.IsNullOrWhiteSpace(entry))
result.Add(entry);
}
return result;
}
[GeneratedRegex("[,;\\s]+", RegexOptions.Compiled)]
private static partial Regex ListSeparatorRegex();
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,329 +1,330 @@
using ChestPreview.Configs;
using ChestPreview.Models;
using ChestPreview.Utils;
using System;
using System.Collections.Generic;
using System.Numerics;
using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.MathTools;
using Vintagestory.GameContent;
namespace ChestPreview.Rendering;
internal class WorldBillboardPresenter(ICoreClientAPI api)
{
private const int multiblock_scan_radius = 2;
private static readonly float front_face_offset = 0.01f;
private readonly ICoreClientAPI api = api;
private readonly List<BillboardTarget> frameBillboards = [];
public IReadOnlyList<BillboardTarget> FrameBillboards => frameBillboards;
public void PrepareFrame(List<PreviewTarget> previewTargets)
{
frameBillboards.Clear();
foreach (PreviewTarget previewTarget in previewTargets)
{
if (!CanPresentAsBillboard(previewTarget))
continue;
if (!TryCreateBillboardTarget(previewTarget, out BillboardTarget billboardTarget))
continue;
frameBillboards.Add(billboardTarget);
}
}
public void Clear()
{
frameBillboards.Clear();
}
private static bool CanPresentAsBillboard(PreviewTarget previewTarget)
{
return previewTarget.Mode is PreviewModes.ON_HOVERED_CONTAINER or PreviewModes.ON_NEARBY_CONTAINERS;
}
private bool TryCreateBillboardTarget(PreviewTarget previewTarget, out BillboardTarget billboardTarget)
{
return TryCreateFrontBillboardTarget(previewTarget, out billboardTarget);
}
private bool TryCreateFrontBillboardTarget(PreviewTarget previewTarget, out BillboardTarget billboardTarget)
{
billboardTarget = default;
Block block = previewTarget.Block;
BlockPos blockPos = previewTarget.BlockEntity.Pos;
GetContainerBounds(block, blockPos, out Vector3 min, out Vector3 max);
if (!TryResolveFacingNormal(previewTarget.Block, previewTarget.BlockEntity, out Vec3f forward, out Vec3f right, out Vec3f up))
return false;
Vector3 centerLocal = (min + max) * 0.5f;
Vector3 halfExtents = (max - min) * 0.5f;
Vector3 rightVector = right.ToVector3();
Vector3 upVector = up.ToVector3();
Vector3 forwardVector = forward.ToVector3();
float halfWidth = Vector3.Dot(Vector3.Abs(rightVector), halfExtents);
float halfHeight = Vector3.Dot(Vector3.Abs(upVector), halfExtents);
float halfDepth = ResolveStableHalfDepth(forwardVector, halfExtents);
float width = halfWidth * 2f;
float height = halfHeight * 2f;
Vector3 center = blockPos.ToVector3() + centerLocal + forwardVector * (halfDepth + front_face_offset);
width = Math.Max(0.05f, width);
height = Math.Max(0.05f, height);
billboardTarget = new BillboardTarget(previewTarget, center.ToVec3d(), right, up, forward, width, height, true);
return true;
}
private static float ResolveStableHalfDepth(Vector3 forward, Vector3 halfExtents)
{
if (MathF.Abs(forward.Y) < 0.5f)
return MathF.Abs(forward.X) >= MathF.Abs(forward.Z) ? halfExtents.X : halfExtents.Z;
return MathF.Abs(forward.Y) >= MathF.Abs(forward.Z) ? halfExtents.Y : halfExtents.Z;
}
private void GetContainerBounds(Block block, BlockPos blockPos, out Vector3 min, out Vector3 max)
{
min = new Vector3(0f, 0f, 0f);
max = new Vector3(1f, 1f, 1f);
ExpandBoundsFromSelectionBoxes(block, blockPos, blockPos, ref min, ref max);
ExpandBoundsFromLinkedMultiblockParts(blockPos, ref min, ref max);
}
private void ExpandBoundsFromLinkedMultiblockParts(BlockPos controllerPos, ref Vector3 min, ref Vector3 max)
{
int minScanX = controllerPos.X - multiblock_scan_radius;
int maxScanX = controllerPos.X + multiblock_scan_radius;
int minScanY = controllerPos.Y - multiblock_scan_radius;
int maxScanY = controllerPos.Y + multiblock_scan_radius;
int minScanZ = controllerPos.Z - multiblock_scan_radius;
int maxScanZ = controllerPos.Z + multiblock_scan_radius;
Vector3 minLocal = min;
Vector3 maxLocal = max;
api.World.BlockAccessor.WalkBlocks(new BlockPos(minScanX, minScanY, minScanZ), new BlockPos(maxScanX, maxScanY, maxScanZ), (partBlock, x, y, z) =>
{
if (x == controllerPos.X && y == controllerPos.Y && z == controllerPos.Z)
return;
if (partBlock.Id == 0 || partBlock is not IMultiblockOffset multiblockOffset)
return;
BlockPos partPos = new(x, y, z);
BlockPos linkedControllerPos = multiblockOffset.GetControlBlockPos(partPos);
if (!IsSameBlockPos(linkedControllerPos, controllerPos))
return;
ExpandBoundsFromSelectionBoxes(partBlock, partPos, controllerPos, ref minLocal, ref maxLocal);
});
min = minLocal;
max = maxLocal;
}
private void ExpandBoundsFromSelectionBoxes(Block block, BlockPos sourcePos, BlockPos originPos, ref Vector3 min, ref Vector3 max)
{
Cuboidf[]? selectionBoxes = block.GetSelectionBoxes(api.World.BlockAccessor, sourcePos);
Vector3 sourceOffset = sourcePos.ToVector3() - originPos.ToVector3();
if (selectionBoxes is not { Length: > 0 })
{
min = Vector3.Min(min, sourceOffset);
max = Vector3.Max(max, sourceOffset + Vector3.One);
return;
}
foreach (Cuboidf selectionBox in selectionBoxes)
{
min = Vector3.Min(min, sourceOffset + selectionBox.Start.ToVector3());
max = Vector3.Max(max, sourceOffset + selectionBox.End.ToVector3());
}
}
private static bool IsSameBlockPos(BlockPos a, BlockPos b)
{
return a.X == b.X && a.Y == b.Y && a.Z == b.Z;
}
private bool TryResolveFacingNormal(Block block, BlockEntity blockEntity, out Vec3f forward, out Vec3f right, out Vec3f up)
{
forward = new Vec3f(0f, 0f, 1f);
right = new Vec3f(1f, 0f, 0f);
up = new Vec3f(0f, 1f, 0f);
if (TryGetMeshAngle(blockEntity, out float meshAngleRadians))
{
// MeshAngle is around Y axis in radians.
forward = new Vec3f(MathF.Sin(meshAngleRadians), 0f, MathF.Cos(meshAngleRadians));
NormalizeFacing(ref forward);
BuildBasisFromForward(forward, out right, out up);
return true;
}
if (TryGetBlockSideFacing(block, out forward))
{
BuildBasisFromForward(forward, out right, out up);
return true;
}
if (!TryGetPlayerFacing(blockEntity.Pos, out forward))
return false;
BuildBasisFromForward(forward, out right, out up);
return true;
}
private bool TryGetPlayerFacing(BlockPos blockPos, out Vec3f facing)
{
facing = new Vec3f(0f, 0f, 1f);
EntityPlayer? playerEntity = api.World.Player?.Entity;
if (playerEntity?.CameraPos == null)
return false;
Vec3d cameraPos = playerEntity.CameraPos + playerEntity.LocalEyePos;
double dx = cameraPos.X - (blockPos.X + 0.5d);
double dz = cameraPos.Z - (blockPos.Z + 0.5d);
if (Math.Abs(dx) <= 0.0001d && Math.Abs(dz) <= 0.0001d)
return false;
double absDx = Math.Abs(dx);
double absDz = Math.Abs(dz);
double diagonalTolerance = Math.Max(absDx, absDz) * 0.65d;
bool isDiagonalView = Math.Abs(absDx - absDz) <= diagonalTolerance;
if (isDiagonalView)
{
Vec3f facingX = dx >= 0d ? new Vec3f(1f, 0f, 0f) : new Vec3f(-1f, 0f, 0f);
Vec3f facingZ = dz >= 0d ? new Vec3f(0f, 0f, 1f) : new Vec3f(0f, 0f, -1f);
int obstructionX = GetFacingObstructionScore(blockPos, facingX);
int obstructionZ = GetFacingObstructionScore(blockPos, facingZ);
if (obstructionX != obstructionZ)
{
facing = obstructionX < obstructionZ ? facingX : facingZ;
return true;
}
}
facing = absDx >= absDz
? (dx >= 0d ? new Vec3f(1f, 0f, 0f) : new Vec3f(-1f, 0f, 0f))
: (dz >= 0d ? new Vec3f(0f, 0f, 1f) : new Vec3f(0f, 0f, -1f));
return true;
}
private int GetFacingObstructionScore(BlockPos blockPos, Vec3f facing)
{
int offsetX = Math.Sign(facing.X);
int offsetZ = Math.Sign(facing.Z);
int score = 0;
for (int yOffset = 0; yOffset <= 1; yOffset++)
{
BlockPos checkPos = new(blockPos.X + offsetX, blockPos.Y + yOffset, blockPos.Z + offsetZ);
if (IsSolidBlock(checkPos))
score++;
}
return score;
}
private bool IsSolidBlock(BlockPos blockPos)
{
Block block = api.World.BlockAccessor.GetBlock(blockPos);
if (block.Id == 0)
return false;
Cuboidf[]? collisionBoxes = block.GetCollisionBoxes(api.World.BlockAccessor, blockPos);
return collisionBoxes is { Length: > 0 };
}
private static bool TryGetBlockSideFacing(Block block, out Vec3f facing)
{
facing = new Vec3f(0f, 0f, 1f);
string? side = block.Variant?["side"];
if (string.IsNullOrWhiteSpace(side))
return false;
switch (side.ToLowerInvariant())
{
case "north":
facing = new Vec3f(0f, 0f, -1f);
return true;
case "south":
facing = new Vec3f(0f, 0f, 1f);
return true;
case "east":
facing = new Vec3f(1f, 0f, 0f);
return true;
case "west":
facing = new Vec3f(-1f, 0f, 0f);
return true;
case "up":
facing = new Vec3f(0f, 1f, 0f);
return true;
case "down":
facing = new Vec3f(0f, -1f, 0f);
return true;
default:
return false;
}
}
private static void BuildBasisFromForward(Vec3f forward, out Vec3f right, out Vec3f up)
{
up = new Vec3f(0f, 1f, 0f);
if (Math.Abs(forward.Y) > 0.5f)
{
up = forward.Y > 0f ? new Vec3f(0f, 0f, -1f) : new Vec3f(0f, 0f, 1f);
right = new Vec3f(1f, 0f, 0f);
return;
}
right = new Vec3f(-forward.Z, 0f, forward.X);
}
private static void NormalizeFacing(ref Vec3f facing)
{
float length = MathF.Sqrt(facing.X * facing.X + facing.Y * facing.Y + facing.Z * facing.Z);
if (length <= 0.0001f)
{
facing = new Vec3f(0f, 0f, 1f);
return;
}
float invLength = 1f / length;
facing = new Vec3f(facing.X * invLength, facing.Y * invLength, facing.Z * invLength);
}
private static bool TryGetMeshAngle(BlockEntity blockEntity, out float radians)
{
if (blockEntity is BlockEntityGenericTypedContainer genericContainer)
{
radians = genericContainer.MeshAngle;
return true;
}
if (blockEntity is BlockEntityCrate crate)
{
radians = crate.MeshAngle;
return true;
}
radians = 0f;
return false;
}
}
using ChestPreview.Configs;
using ChestPreview.Models;
using ChestPreview.Utils;
using System;
using System.Collections.Generic;
using System.Numerics;
using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.MathTools;
using Vintagestory.GameContent;
namespace ChestPreview.Rendering;
internal class WorldBillboardPresenter(ICoreClientAPI api, Config config)
{
private const int multiblock_scan_radius = 2;
private static readonly float front_face_offset = 0.05f;
private readonly ICoreClientAPI api = api;
private readonly Config config = config;
private readonly List<BillboardTarget> frameBillboards = [];
public IReadOnlyList<BillboardTarget> FrameBillboards => frameBillboards;
public void PrepareFrame(List<PreviewTarget> previewTargets)
{
frameBillboards.Clear();
foreach (PreviewTarget previewTarget in previewTargets)
{
if (!CanPresentAsBillboard(previewTarget))
continue;
if (!TryCreateBillboardTarget(previewTarget, out BillboardTarget billboardTarget))
continue;
frameBillboards.Add(billboardTarget);
}
}
public void Clear()
{
frameBillboards.Clear();
}
private static bool CanPresentAsBillboard(PreviewTarget previewTarget)
{
return previewTarget.Mode is PreviewModes.ON_HOVERED_CONTAINER or PreviewModes.ON_NEARBY_CONTAINERS;
}
private bool TryCreateBillboardTarget(PreviewTarget previewTarget, out BillboardTarget billboardTarget)
{
return TryCreateFrontBillboardTarget(previewTarget, out billboardTarget);
}
private bool TryCreateFrontBillboardTarget(PreviewTarget previewTarget, out BillboardTarget billboardTarget)
{
billboardTarget = default;
Block block = previewTarget.Block;
BlockPos blockPos = previewTarget.BlockEntity.Pos;
GetContainerBounds(block, blockPos, out Vector3 min, out Vector3 max);
if (!TryResolveFacingNormal(previewTarget.Block, previewTarget.BlockEntity, out Vec3f forward, out Vec3f right, out Vec3f up))
return false;
Vector3 centerLocal = (min + max) * 0.5f;
Vector3 halfExtents = (max - min) * 0.5f;
Vector3 rightVector = right.ToVector3();
Vector3 upVector = up.ToVector3();
Vector3 forwardVector = forward.ToVector3();
float halfWidth = Vector3.Dot(Vector3.Abs(rightVector), halfExtents);
float halfHeight = Vector3.Dot(Vector3.Abs(upVector), halfExtents);
float halfDepth = ResolveStableHalfDepth(forwardVector, halfExtents);
float width = halfWidth * 2f;
float height = halfHeight * 2f;
Vector3 center = blockPos.ToVector3() + centerLocal + forwardVector * (halfDepth + front_face_offset);
width = Math.Max(0.05f, width);
height = Math.Max(0.05f, height);
billboardTarget = new BillboardTarget(previewTarget, center.ToVec3d(), right, up, forward, width, height, true);
return true;
}
private static float ResolveStableHalfDepth(Vector3 forward, Vector3 halfExtents)
{
if (MathF.Abs(forward.Y) < 0.5f)
return MathF.Abs(forward.X) >= MathF.Abs(forward.Z) ? halfExtents.X : halfExtents.Z;
return MathF.Abs(forward.Y) >= MathF.Abs(forward.Z) ? halfExtents.Y : halfExtents.Z;
}
private void GetContainerBounds(Block block, BlockPos blockPos, out Vector3 min, out Vector3 max)
{
min = new Vector3(0f, 0f, 0f);
max = new Vector3(1f, 1f, 1f);
ExpandBoundsFromSelectionBoxes(block, blockPos, blockPos, ref min, ref max);
ExpandBoundsFromLinkedMultiblockParts(blockPos, ref min, ref max);
}
private void ExpandBoundsFromLinkedMultiblockParts(BlockPos controllerPos, ref Vector3 min, ref Vector3 max)
{
int minScanX = controllerPos.X - multiblock_scan_radius;
int maxScanX = controllerPos.X + multiblock_scan_radius;
int minScanY = controllerPos.Y - multiblock_scan_radius;
int maxScanY = controllerPos.Y + multiblock_scan_radius;
int minScanZ = controllerPos.Z - multiblock_scan_radius;
int maxScanZ = controllerPos.Z + multiblock_scan_radius;
Vector3 minLocal = min;
Vector3 maxLocal = max;
api.World.BlockAccessor.WalkBlocks(new BlockPos(minScanX, minScanY, minScanZ), new BlockPos(maxScanX, maxScanY, maxScanZ), (partBlock, x, y, z) =>
{
if (x == controllerPos.X && y == controllerPos.Y && z == controllerPos.Z)
return;
if (partBlock.Id == 0 || partBlock is not IMultiblockOffset multiblockOffset)
return;
BlockPos partPos = new(x, y, z);
BlockPos linkedControllerPos = multiblockOffset.GetControlBlockPos(partPos);
if (!IsSameBlockPos(linkedControllerPos, controllerPos))
return;
ExpandBoundsFromSelectionBoxes(partBlock, partPos, controllerPos, ref minLocal, ref maxLocal);
});
min = minLocal;
max = maxLocal;
}
private void ExpandBoundsFromSelectionBoxes(Block block, BlockPos sourcePos, BlockPos originPos, ref Vector3 min, ref Vector3 max)
{
Cuboidf[]? selectionBoxes = block.GetSelectionBoxes(api.World.BlockAccessor, sourcePos);
Vector3 sourceOffset = sourcePos.ToVector3() - originPos.ToVector3();
if (selectionBoxes is not { Length: > 0 })
{
min = Vector3.Min(min, sourceOffset);
max = Vector3.Max(max, sourceOffset + Vector3.One);
return;
}
foreach (Cuboidf selectionBox in selectionBoxes)
{
min = Vector3.Min(min, sourceOffset + selectionBox.Start.ToVector3());
max = Vector3.Max(max, sourceOffset + selectionBox.End.ToVector3());
}
}
private static bool IsSameBlockPos(BlockPos a, BlockPos b)
{
return a.X == b.X && a.Y == b.Y && a.Z == b.Z;
}
private bool TryResolveFacingNormal(Block block, BlockEntity blockEntity, out Vec3f forward, out Vec3f right, out Vec3f up)
{
forward = new Vec3f(0f, 0f, 1f);
right = new Vec3f(1f, 0f, 0f);
up = new Vec3f(0f, 1f, 0f);
if (!config.BillboardIgnoreFront && TryGetMeshAngle(blockEntity, out float meshAngleRadians))
{
// MeshAngle is around Y axis in radians.
forward = new Vec3f(MathF.Sin(meshAngleRadians), 0f, MathF.Cos(meshAngleRadians));
NormalizeFacing(ref forward);
BuildBasisFromForward(forward, out right, out up);
return true;
}
if (!config.BillboardIgnoreFront && TryGetBlockSideFacing(block, out forward))
{
BuildBasisFromForward(forward, out right, out up);
return true;
}
if (!TryGetPlayerFacing(blockEntity.Pos, out forward))
return false;
BuildBasisFromForward(forward, out right, out up);
return true;
}
private bool TryGetPlayerFacing(BlockPos blockPos, out Vec3f facing)
{
facing = new Vec3f(0f, 0f, 1f);
EntityPlayer? playerEntity = api.World.Player?.Entity;
if (playerEntity?.CameraPos == null)
return false;
Vec3d cameraPos = playerEntity.CameraPos + playerEntity.LocalEyePos;
double dx = cameraPos.X - (blockPos.X + 0.5d);
double dz = cameraPos.Z - (blockPos.Z + 0.5d);
if (Math.Abs(dx) <= 0.0001d && Math.Abs(dz) <= 0.0001d)
return false;
double absDx = Math.Abs(dx);
double absDz = Math.Abs(dz);
double diagonalTolerance = Math.Max(absDx, absDz) * 0.65d;
bool isDiagonalView = Math.Abs(absDx - absDz) <= diagonalTolerance;
if (isDiagonalView)
{
Vec3f facingX = dx >= 0d ? new Vec3f(1f, 0f, 0f) : new Vec3f(-1f, 0f, 0f);
Vec3f facingZ = dz >= 0d ? new Vec3f(0f, 0f, 1f) : new Vec3f(0f, 0f, -1f);
int obstructionX = GetFacingObstructionScore(blockPos, facingX);
int obstructionZ = GetFacingObstructionScore(blockPos, facingZ);
if (obstructionX != obstructionZ)
{
facing = obstructionX < obstructionZ ? facingX : facingZ;
return true;
}
}
facing = absDx >= absDz
? (dx >= 0d ? new Vec3f(1f, 0f, 0f) : new Vec3f(-1f, 0f, 0f))
: (dz >= 0d ? new Vec3f(0f, 0f, 1f) : new Vec3f(0f, 0f, -1f));
return true;
}
private int GetFacingObstructionScore(BlockPos blockPos, Vec3f facing)
{
int offsetX = Math.Sign(facing.X);
int offsetZ = Math.Sign(facing.Z);
int score = 0;
for (int yOffset = 0; yOffset <= 1; yOffset++)
{
BlockPos checkPos = new(blockPos.X + offsetX, blockPos.Y + yOffset, blockPos.Z + offsetZ);
if (IsSolidBlock(checkPos))
score++;
}
return score;
}
private bool IsSolidBlock(BlockPos blockPos)
{
Block block = api.World.BlockAccessor.GetBlock(blockPos);
if (block.Id == 0)
return false;
Cuboidf[]? collisionBoxes = block.GetCollisionBoxes(api.World.BlockAccessor, blockPos);
return collisionBoxes is { Length: > 0 };
}
private static bool TryGetBlockSideFacing(Block block, out Vec3f facing)
{
facing = new Vec3f(0f, 0f, 1f);
string? side = block.Variant?["side"];
if (string.IsNullOrWhiteSpace(side))
return false;
switch (side.ToLowerInvariant())
{
case "north":
facing = new Vec3f(0f, 0f, 1f);
return true;
case "south":
facing = new Vec3f(0f, 0f, -1f);
return true;
case "east":
facing = new Vec3f(-1f, 0f, 0f);
return true;
case "west":
facing = new Vec3f(1f, 0f, 0f);
return true;
case "up":
facing = new Vec3f(0f, 1f, 0f);
return true;
case "down":
facing = new Vec3f(0f, -1f, 0f);
return true;
default:
return false;
}
}
private static void BuildBasisFromForward(Vec3f forward, out Vec3f right, out Vec3f up)
{
up = new Vec3f(0f, 1f, 0f);
if (Math.Abs(forward.Y) > 0.5f)
{
up = forward.Y > 0f ? new Vec3f(0f, 0f, -1f) : new Vec3f(0f, 0f, 1f);
right = new Vec3f(1f, 0f, 0f);
return;
}
right = new Vec3f(-forward.Z, 0f, forward.X);
}
private static void NormalizeFacing(ref Vec3f facing)
{
float length = MathF.Sqrt(facing.X * facing.X + facing.Y * facing.Y + facing.Z * facing.Z);
if (length <= 0.0001f)
{
facing = new Vec3f(0f, 0f, 1f);
return;
}
float invLength = 1f / length;
facing = new Vec3f(facing.X * invLength, facing.Y * invLength, facing.Z * invLength);
}
private static bool TryGetMeshAngle(BlockEntity blockEntity, out float radians)
{
if (blockEntity is BlockEntityGenericTypedContainer genericContainer)
{
radians = genericContainer.MeshAngle;
return true;
}
if (blockEntity is BlockEntityCrate crate)
{
radians = crate.MeshAngle;
return true;
}
radians = 0f;
return false;
}
}

View File

@@ -19,7 +19,7 @@ internal class WorldBillboardRenderer(ICoreClientAPI api, Config config, CardRen
private readonly List<PreviewTarget> frameTargets = [];
private readonly CardRenderer cardRenderer = cardRenderer;
private readonly PreviewTargetProvider targetProvider = new(api, config);
private readonly WorldBillboardPresenter worldBillboardPresenter = new(api);
private readonly WorldBillboardPresenter worldBillboardPresenter = new(api, config);
private readonly MeshRef quadMeshRef = api.Render.UploadMesh(
QuadMeshUtil.GetCustomQuadModelData(
1f,

View File

@@ -21,10 +21,10 @@
"clientSide": true
},
{
"code": "HoldKey",
"comment": "config-desc-HoldKey",
"code": "BillboardIgnoreFront",
"comment": "config-desc-BillboardIgnoreFront",
"type": "boolean",
"default": true,
"default": false,
"clientSide": true
},
{
@@ -72,7 +72,7 @@
"code": "WhitelistedContainers",
"comment": "config-desc-WhitelistedContainers",
"type": "string",
"default": "barrel, crate, chest-*, trunk-*, storagevessel-*, stationarybasket-*, labeledchest-*",
"default": "barrel, crate, chest-*, trunk-*, storagevessel-*, stationarybasket-*, labeledchest-*, labeledtrunk-*, groundstorage, beehive-*",
"clientSide": true
},
{
@@ -81,6 +81,13 @@
"type": "string",
"default": "",
"clientSide": true
},
{
"code": "GroundStorageOnlyContainers",
"comment": "config-desc-GroundStorageOnlyContainers",
"type": "boolean",
"default": true,
"clientSide": true
}
]
}

View File

@@ -1,12 +1,15 @@
{
"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.",
"config-desc-PreviewNearbyRadius": "Radius for \"Preview containers nearby\".",
"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."
}

View File

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

View File

@@ -4,6 +4,14 @@
<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>
@@ -17,4 +25,15 @@
<HintPath>$(VINTAGE_STORY)/VintagestoryAPI.dll</HintPath>
</Reference>
</ItemGroup>
<ItemGroup>
<Reference Include="configlib" Condition="'$(ConfigLibAvailable)' == 'true'">
<HintPath>$(VS_CONFIGLIB)</HintPath>
<Private>False</Private>
</Reference>
</ItemGroup>
<Target Name="WarnWithoutConfigLib" BeforeTargets="CoreCompile" Condition="'$(ConfigLibAvailable)' != 'true'">
<Warning Text="No VS_CONFIGLIB - will compile without supporting ConfigLib. Set VS_CONFIGLIB env var to a path that contains the configlib's dlls." />
</Target>
</Project>

0
ChestPreview/build.sh Normal file → Executable file
View File

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 OrekiWoof
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -9,8 +9,8 @@
### Required env vars
- `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_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_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