Sticky-ChestContents icon

ChestContents

A Valheim plugin to index and search chest contents, showing the chest with the most of a searched item.

Last updated a day ago
Total downloads 141
Total rating 0 
Categories Mods Misc Client-side Utility
Dependency string Sticky-ChestContents-1.1.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2117 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.2117
ValheimModding-Jotunn-2.25.0 icon
ValheimModding-Jotunn

Jötunn (/ˈjɔːtʊn/, 'giant'), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Preferred version: 2.25.0

README

ChestContents

Effect Example

Meta Pane Example

Introduction

ChestContents is a Valheim mod/plugin that helps you keep track of all your chests and their contents. It provides an at-a-glance overview of how many chests are indexed and what items are stored where, making inventory management much easier.

Features

  • Displays the number of indexed chests as a status effect (see the first image above).
  • Provides a searchable meta pane to quickly find where items are stored (see the second image above).
  • Command-line interface for searching chests by item name.
  • Meta data viewing: Run the default /searchchests command with no arguments to view meta data about the mod's state. This does not reset the indexed chests or cached data.
  • Configurable options: Use the /chestconfig or /cc command to edit configuration options and preview the effect on yourself in real time.

Commands

Search Chests Command

You can search for items across all indexed chests using the following command:

/searchchests <item name>

Aliases

  • /cs
  • /sc

Example Usage

To find the chest containing the most mushrooms, type:

/searchchests mushroom

This will indicate the chest with the highest quantity of mushrooms in your indexed chests, showing its location and the quantity found.

Meta Data and State

Run the default command with no arguments:

/searchchests

This will display meta data about the mod's current state, such as the number of indexed chests and items. It does not reset the mod's state or cached data.

Config Command

Edit configuration and preview effects:

/chestconfig

or

/cc

This command allows you to edit some configuration options for the mod and preview the effect on yourself immediately.

Best Practices

  • Use the search command with partial item names for broader results (e.g., /searchchests mush will match "mushroom").

Installation

  1. Download the latest release of ChestContents.dll and the matching named folder (ChestContents).
  2. Place them in your BepInEx/plugins folder.
  3. Launch Valheim and enjoy easier item finding!

Contributing

Pull requests and suggestions are welcome! Please open an issue to discuss any major changes before submitting a PR.

License

MIT