Compare commits

...

10 Commits

12 changed files with 1410 additions and 1161 deletions

View File

@@ -1,5 +1,5 @@
{
"total": 66247,
"total": 75390,
"sessions": [
{
"begin": "2026-03-11T23:50:47+01:00",
@@ -65,6 +65,16 @@
"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
}
]
}

View File

@@ -6,6 +6,8 @@ public sealed class Config
public bool HoldKey { get; set; } = true;
public bool BillboardIgnoreFront { get; set; } = false;
public int BillboardColumnsPerBlock { get; set; } = 4;
public int ColumnsUnderCursor { get; set; } = 10;
@@ -14,7 +16,9 @@ public sealed class Config
public bool WhitelistedContainersOnly { get; set; } = true;
public string WhitelistedContainers { get; set; } = "barrel, crate, chest-*, trunk-*, storagevessel-*, stationarybasket-*, labeledchest-*";
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

@@ -11,6 +11,7 @@ using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.MathTools;
using Vintagestory.API.Util;
using Vintagestory.GameContent;
namespace ChestPreview;
@@ -39,7 +40,7 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
if (!TryGetHoveredContainer(out Block hoveredBlock, out BlockEntity hoveredBlockEntity))
return;
if (!CanAccessContainer(hoveredBlockEntity))
if (!CanAccessContainer(hoveredBlock, hoveredBlockEntity))
return;
if (!IsContainerAllowed(hoveredBlock))
@@ -70,7 +71,7 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
if (block.Id == 0)
continue;
if (!CanAccessContainer(blockEntity))
if (!CanAccessContainer(block, blockEntity))
continue;
if (!IsContainerAllowed(block))
@@ -134,10 +135,14 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
if (currentBlockSelection == null)
return false;
BlockEntity? currentBlockEntity = api.World.BlockAccessor.GetBlockEntity(currentBlockSelection.Position);
if (currentBlockEntity is IBlockEntityContainer)
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;
}
@@ -159,14 +164,17 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
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;
BlockEntity? blockEntity = api.World.BlockAccessor.GetBlockEntity(controllerPos);
if (!HasPreviewableStorage(controllerBlock, controllerPos, blockEntity))
return false;
if (blockEntity == null)
return false;
controllerBlockEntity = blockEntity;
return true;
}
@@ -196,11 +204,15 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
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)
if (block.Id == 0)
return;
if (block.Id == 0)
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);
@@ -232,17 +244,52 @@ internal partial class PreviewTargetProvider(ICoreClientAPI api, Config config)
}
}
private bool CanAccessContainer(BlockEntity blockEntity)
private bool CanAccessContainer(Block block, BlockEntity blockEntity)
{
if (blockEntity is not IBlockEntityContainer container || container.Inventory is not InventoryBase inventory)
if (config.GroundStorageOnlyContainers && blockEntity is BlockEntityGroundStorage && !HasHeldBagInGroundStorage(blockEntity))
return false;
IPlayer? player = api.World.Player;
EntityPlayer? playerEntity = player?.Entity;
if (player == null || playerEntity == null)
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;
return inventory.CanPlayerAccess(player, playerEntity.GetPos());
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)

View File

@@ -4,12 +4,15 @@ using ChestPreview.Models;
using ChestPreview.Utils;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text;
using Vintagestory.API.Client;
using Vintagestory.API.Common;
using Vintagestory.API.Config;
using Vintagestory.API.Datastructures;
using Vintagestory.API.MathTools;
using Vintagestory.GameContent;
namespace ChestPreview.Rendering;
@@ -28,6 +31,8 @@ internal class CardRenderer(ICoreClientAPI api, Config config) : IDisposable
private readonly ICoreClientAPI api = api;
private readonly Config config = config;
private readonly TreeAttribute tempTree = new();
private readonly InventoryGeneric sharedPreviewInventory = new(64, "inventory-preview", null, null);
private readonly Dictionary<string, CachedCardTexture> cardTextureByTarget = [];
private readonly Dictionary<int, LoadedTexture> atlasTextureById = [];
private readonly Dictionary<string, RenderedIconEntry> renderedIconByStack = [];
@@ -46,9 +51,33 @@ internal class CardRenderer(ICoreClientAPI api, Config config) : IDisposable
{
texture = null!;
if (target.BlockEntity is not IBlockEntityContainer container || container.Inventory is not InventoryBase inventory)
if (TryResolveHeldBagContents(target.BlockEntity, out List<ItemStack>? bagContents))
{
string bagTargetKey = CreateTargetKey(target.BlockEntity.Pos);
if (!cardTextureByTarget.TryGetValue(bagTargetKey, out CachedCardTexture? bagCachedTexture))
{
bagCachedTexture = new CachedCardTexture(new LoadedTexture(api), string.Empty);
cardTextureByTarget[bagTargetKey] = bagCachedTexture;
}
BuildLayoutFromStacks(bagContents, maxColumns, out List<GroupedItemCell> bagCells, out int bagUsedColumns, out int bagUsedRows, out string bagFingerprint);
if (bagCachedTexture.Fingerprint != bagFingerprint)
{
ComposeTexture(bagCachedTexture.Texture, bagCells, bagUsedColumns, bagUsedRows);
bagCachedTexture.Fingerprint = bagFingerprint;
}
texture = bagCachedTexture.Texture;
return texture.TextureId != 0;
}
if (config.GroundStorageOnlyContainers && target.BlockEntity is BlockEntityGroundStorage)
return false;
if (!TryResolveInventory(target, out InventoryBase? resolvedInventory))
return false;
InventoryBase inventory = resolvedInventory;
IPlayer? player = api.World.Player;
EntityPlayer? playerEntity = player?.Entity;
if (player == null || playerEntity == null || !inventory.CanPlayerAccess(player, playerEntity.GetPos()))
@@ -61,17 +90,111 @@ internal class CardRenderer(ICoreClientAPI api, Config config) : IDisposable
cardTextureByTarget[targetKey] = cachedTexture;
}
BuildLayout(inventory, maxColumns, out List<GroupedItemCell> cells, out int usedColumns, out int usedRows, out string fingerprint);
if (cachedTexture.Fingerprint != fingerprint)
BuildLayout(inventory, maxColumns, out List<GroupedItemCell> cellsFromInventory, out int usedColumnsFromInventory, out int usedRowsFromInventory, out string fingerprintFromInventory);
if (cachedTexture.Fingerprint != fingerprintFromInventory)
{
ComposeTexture(cachedTexture.Texture, cells, usedColumns, usedRows);
cachedTexture.Fingerprint = fingerprint;
ComposeTexture(cachedTexture.Texture, cellsFromInventory, usedColumnsFromInventory, usedRowsFromInventory);
cachedTexture.Fingerprint = fingerprintFromInventory;
}
texture = cachedTexture.Texture;
return texture.TextureId != 0;
}
private bool TryResolveHeldBagContents(BlockEntity blockEntity, [NotNullWhen(true)] out List<ItemStack>? contents)
{
contents = null;
if (blockEntity is not BlockEntityGroundStorage groundStorage)
return false;
foreach (ItemSlot? slot in groundStorage.Inventory)
{
ItemStack? bagStack = slot?.Itemstack;
if (bagStack?.Collectible is not { } collectible)
continue;
IHeldBag? heldBag = collectible.GetCollectibleInterface<IHeldBag>();
if (heldBag == null)
continue;
ItemStack[]? bagContents;
try
{
bagContents = heldBag.GetContents(bagStack, api.World);
}
catch
{
continue;
}
if (bagContents == null)
continue;
contents = [];
foreach (ItemStack contentStack in bagContents)
{
if (contentStack == null || contentStack.StackSize <= 0)
continue;
contents.Add(contentStack);
}
return true;
}
return false;
}
private bool TryResolveInventory(PreviewTarget target, [NotNullWhen(true)] out InventoryBase? inventory)
{
inventory = null;
if (TryResolveSpecialInventory(target.BlockEntity, out InventoryBase? specialInventory))
{
inventory = specialInventory;
return true;
}
BlockPos pos = target.BlockEntity.Pos;
if (target.Block.GetInterface<IBlockEntityContainer>(api.World, pos) is { } container && container.Inventory is InventoryBase blockInventory)
{
inventory = blockInventory;
return true;
}
return false;
}
private bool TryResolveSpecialInventory(BlockEntity blockEntity, [NotNullWhen(true)] out InventoryBase? inventory)
{
inventory = null;
if (blockEntity is not BlockEntityBloomery and not BlockEntityForge)
return false;
tempTree.Clear();
blockEntity.ToTreeAttributes(tempTree);
ITreeAttribute sourceTree = tempTree;
if (blockEntity is BlockEntityForge)
{
ITreeAttribute? forgeInventoryTree = tempTree.GetTreeAttribute("inventory");
if (forgeInventoryTree != null)
sourceTree = forgeInventoryTree;
}
sharedPreviewInventory.FromTreeAttributes(sourceTree);
if (blockEntity is BlockEntityForge && sharedPreviewInventory[0].Itemstack == null)
{
ItemStack? legacyContents = tempTree.GetItemstack("contents");
if (legacyContents != null)
sharedPreviewInventory[0].Itemstack = legacyContents;
}
inventory = sharedPreviewInventory;
return true;
}
public void DrawAtScreen(float x, float y, LoadedTexture texture)
{
if (texture.TextureId == 0)
@@ -105,16 +228,29 @@ internal class CardRenderer(ICoreClientAPI api, Config config) : IDisposable
}
private void BuildLayout(IInventory inventory, int maxColumns, out List<GroupedItemCell> cells, out int usedColumns, out int usedRows, out string fingerprint)
{
List<ItemStack> stacks = [];
foreach (ItemSlot? slot in inventory)
{
if (slot?.Itemstack == null || slot.Empty)
continue;
stacks.Add(slot.Itemstack);
}
BuildLayoutFromStacks(stacks, maxColumns, out cells, out usedColumns, out usedRows, out fingerprint);
}
private void BuildLayoutFromStacks(IEnumerable<ItemStack> stacks, int maxColumns, out List<GroupedItemCell> cells, out int usedColumns, out int usedRows, out string fingerprint)
{
List<GroupedItemCell> groupedItems = [];
int naturalOrder = 0;
foreach (ItemSlot? slot in inventory)
foreach (ItemStack stack in stacks)
{
if (slot == null || slot.Empty || slot.Itemstack == null)
if (stack == null || stack.StackSize <= 0)
continue;
ItemStack stack = slot.Itemstack;
int existingIndex = FindMatchingItemIndex(groupedItems, stack);
if (existingIndex >= 0)
{

View File

@@ -11,12 +11,13 @@ using Vintagestory.GameContent;
namespace ChestPreview.Rendering;
internal class WorldBillboardPresenter(ICoreClientAPI api)
internal class WorldBillboardPresenter(ICoreClientAPI api, Config config)
{
private const int multiblock_scan_radius = 2;
private static readonly float front_face_offset = 0.01f;
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;
@@ -162,7 +163,7 @@ internal class WorldBillboardPresenter(ICoreClientAPI api)
right = new Vec3f(1f, 0f, 0f);
up = new Vec3f(0f, 1f, 0f);
if (TryGetMeshAngle(blockEntity, out float meshAngleRadians))
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));
@@ -171,7 +172,7 @@ internal class WorldBillboardPresenter(ICoreClientAPI api)
return true;
}
if (TryGetBlockSideFacing(block, out forward))
if (!config.BillboardIgnoreFront && TryGetBlockSideFacing(block, out forward))
{
BuildBasisFromForward(forward, out right, out up);
return true;
@@ -260,16 +261,16 @@ internal class WorldBillboardPresenter(ICoreClientAPI api)
switch (side.ToLowerInvariant())
{
case "north":
facing = new Vec3f(0f, 0f, -1f);
return true;
case "south":
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);
facing = new Vec3f(-1f, 0f, 0f);
return true;
case "west":
facing = new Vec3f(-1f, 0f, 0f);
facing = new Vec3f(1f, 0f, 0f);
return true;
case "up":
facing = new Vec3f(0f, 1f, 0f);

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

@@ -27,6 +27,13 @@
"default": true,
"clientSide": true
},
{
"code": "BillboardIgnoreFront",
"comment": "config-desc-BillboardIgnoreFront",
"type": "boolean",
"default": false,
"clientSide": true
},
{
"code": "BillboardColumnsPerBlock",
"comment": "config-desc-BillboardColumnsPerBlock",
@@ -72,7 +79,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 +88,13 @@
"type": "string",
"default": "",
"clientSide": true
},
{
"code": "GroundStorageOnlyContainers",
"comment": "config-desc-GroundStorageOnlyContainers",
"type": "boolean",
"default": true,
"clientSide": true
}
]
}

View File

@@ -3,10 +3,12 @@
"hotkey-preview-containers-nearby": "Preview 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": "1.2.0",
"dependencies": {
"game": "1.21.0"
},

View File

@@ -4,6 +4,9 @@
<TargetFramework>net8.0</TargetFramework>
<RunWorkingDirectory>$(MSBuildProjectDirectory)</RunWorkingDirectory>
<Configurations>Debug;Release;Version22</Configurations>
<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>
<ItemGroup>
@@ -17,4 +20,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.