You are viewing a potentially older version of this package. View all versions.
Dyls123-ItemPull-0.5.0 icon

ItemPull

Client-side chest search, locate, pull, deposit and group sorting. Lock items and craft or build with nearby resources. Configurable range, shortcuts, item groups and optional biome sorting.

By Dyls123
Date uploaded a month ago
Version 0.5.0
Download link Dyls123-ItemPull-0.5.0.zip
Downloads 35
Dependency string Dyls123-ItemPull-0.5.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2350 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2350

README

ItemPull

About

Search, locate, pull and deposit items, and craft or build with resources in nearby chests. Transfers follow the game's chest access, ownership and inventory rules. Search results and Locate markers are visible only to you.

Requires BepInEx 5 for Valheim. Jötunn is not required.

How to use

  1. Open your inventory and select ItemPull above the player inventory.
  2. Type part of an item's name. Search is case-insensitive and uses the game's translated item names. An empty search lists all available item types.
  3. Each result shows its total quantity and the number of matching chests. Quality and appearance variants have separate results. Use Previous/Next for additional pages.
  4. Select Locate to close the inventory and show cyan chest outlines with chest names, item quantities and distances. The markers show through walls and expire after 4 seconds by default. Off-screen labels appear at the edge of the screen.
  5. Enter a positive Pull amount, or select All, then select the result's Pull button. Items are taken from matching chests nearest first. Full inventories accept only what fits; remaining items stay in storage.

Deposit: with your inventory open, hover an item in your personal inventory and click the scroll wheel (middle mouse). The clicked, unequipped stack moves into accessible chests containing that exact item first, nearest first, then chests containing only items in the same configured group. It can spread across several chests when needed. Other stacks in your inventory remain untouched. The ItemPull panel does not need to be open. If no eligible chest is nearby, nothing happens. Full chests leave the remainder in your inventory. Contents and group settings are checked again after access is granted.

Middle-click also works while a container is open. Your own open, owned chest can receive items without a second access request and stays open afterwards. Chests being used by another player are skipped. Hover your personal inventory, rather than an item inside the container.

Deposit All: select the button beside ItemPull above your inventory. It applies the same exact-first, then group routing to each unlocked stack. Locked, equipped, quest and unmatched items stay in your inventory, along with anything that cannot fit. Empty chests are never seeded. Closing inventory cancels the remaining batch.

Group sorting: enabled by default. For example, Fine Wood can enter a chest containing only Wood and Core Wood even when it has no Fine Wood yet. A chest containing Wood and Stone is mixed, so it accepts exact matches only. An unrecognised item in a chest also prevents inferring its group. Seed an empty chest manually with one item from your intended group. The mod deposits personal stock; it does not rearrange existing chest contents.

Item locks: hover a stack and press Alt + middle-click to lock or unlock it. A gold [L] marker and tooltip identify locked stacks. Locks block both Deposit All and middle-click deposit. They follow the item through saves, moves, splits, merges and upgrades; when locked and unlocked stacks merge, the combined stack is locked. The lock protects against automatic deposits; it does not prevent ordinary manual item movement or resource consumption.

Crafting and building: use the normal crafting, upgrade and build controls. Nearby chest materials count toward the requirements using the same configured radius. Personal resources are consumed first, followed by the exact shortage from nearby accessible chests, nearest first. Ingredients do not need spare inventory slots, but crafted results still need normal inventory space. Recipe discovery, station levels, placement rules, stamina, durability and output amounts follow the native game.

Chest access is checked before completing an action; denied, busy or unavailable chests cannot provide materials. Keep the placement target steady while access is pending. Moving or rotating the target cancels that build; click again at the new target. Closing inventory or pressing Craft Cancel cancels pending crafting. You can disable chest crafting and chest building separately in the config.

Deposit ignores other UI covering an inventory item, typing, item dragging and split dialogs. Exact matches compare item name, quality, appearance variant and world level. Group membership is based on item identity/type; native transfers preserve stack metadata and only merge compatible items. The shortcut supports keyboard keys, mouse buttons and modifiers; rebinding left/right click gives Deposit priority over native drag/equip for that gesture.

Search refreshes after typing and when transfers finish. Refresh updates results after another player changes a chest. Pull and Locate recheck results when selected. Closing the inventory cancels pending transfers; already transferred items remain where they were moved. Closing only the ItemPull panel leaves an authorised transfer running.

Pull follows normal inventory stacking and weight behaviour. It can encumber your character. Item properties are cloned by the game's native transfer method; merging compatible stacks follows the game's normal rules.

Configuration

The first launch creates BepInEx/config/Dyls123.ItemPull.cfg. Edit it with the game closed, or use a compatible in-game config manager. File edits require a reload or restart; config-manager changes apply to the next relevant action. Existing values are carried into the numbered sections automatically. If both an old and a new section contain the same setting, the new section takes priority.

Section / Setting Default Purpose
10 - Search / Radius 60 Range in metres for search, pull, deposit, crafting and building; 1–100.
11 - Resources / CraftFromChests true Use nearby materials for crafting and upgrades.
11 - Resources / BuildFromChests true Use nearby materials for building.
12 - Grouping / Enabled true Allow group-based deposits.
12 - Grouping / UseBiomeGroups false Choose biome groups instead of standard categories.
12 - Grouping / ApplyToMiddleClick true Apply group routing to single-stack deposits.
13 - Groups… / Name, Items Included categories Standard group names and item lists.
14 - CustomGroups… / Name, Items Empty Five custom groups with priority over presets.
15 - BiomeGroups… / Name, Items Included biome lists Optional biome presets.
30 - Keybinds / DepositItem Mouse2 Deposit the hovered stack.
30 - Keybinds / LockItem Mouse2 + LeftAlt Toggle a stack's deposit lock.
40 - Locate / Duration 4 Local marker duration in seconds; 3–120.
90 - Server / LockConfiguration true Lock synced gameplay and group settings to server administrators.

Shortcuts support modifiers, for example Mouse2 + LeftControl, and None disables them. If both match, locking takes priority.

Editing groups

Standard lists use 13 - Groups..., custom lists use 14 - CustomGroups..., and biome lists use 15 - BiomeGroups.... All groups are in the same BepInEx/config/Dyls123.ItemPull.cfg. Existing configs retain their custom group names and lists.

  • 20 standard categories: Wood; Stone and Minerals; Ore and Scrap; Metal Bars; Hides and Leather; Creature Materials; Seeds and Planting; Cooking Ingredients; Mead Bases; Mead and Potions; Prepared Food; Textiles and Fibres; Fuel and Resin; Valuables; Trophies; Tools and Utility; Weapons and Shields; Ammunition; Armour and Clothing; Special Materials.
  • Nine optional biome presets: Meadows, Black Forest, Swamp, Mountains, Plains, Mistlands, Ashlands, Deep North and Ocean. These describe item origin/progression, independent of where you put the chest. They are editable starting lists, not an exhaustive classification of every item or mod. Shared items use the first matching preset. Deep North entries use IDs present in the installed game; unavailable IDs on older versions simply never match.
  • Five blank custom groups: 14 - CustomGroups.01 through 14 - CustomGroups.05. Fill in both Name and Items to activate one. Custom groups work with either standard or biome mode and have priority over both.

Each section has an editable Name and comma-separated Items. A blank name or item list disables that group. Keep section headers unchanged. Members use internal prefab IDs, not translated display names: for example, RoundLog is Core Wood and ElderBark is Ancient Bark. Matching ignores case and spaces around entries. Semicolons also separate entries.

Example custom group:

[14 - CustomGroups.01]
Name = My Building Materials
Items = Wood, FineWood, RoundLog, Stone, MyModMaterial*

The * wildcard matches any characters in a prefab ID. type:Trophy, type:Tool and similar native ItemType selectors match whole item types, including modded items of that type. Invalid type selectors are ignored. Standard presets use these selectors for food, equipment and other broad categories; clear or replace them when you want explicit membership only.

An item belongs to one group: custom slots in number order first, followed by the active mode's groups in number order. This lets a custom group override a built-in rule without editing that rule. For example, the custom group above groups Stone with Wood instead of the usual mineral category. Items without any matching rule still deposit into exact-match chests. Renaming a group does not change its priority.

Set UseBiomeGroups = true to choose biome sorting instead of standard categories. Set Enabled = false to disable all group routing, including custom and biome groups. These settings affect deposits only; crafting, building, searching and pulling retain their existing behaviour.

The radius is a three-dimensional distance from your character, not the camera. Only loaded, accessible static chests are searched. Increasing the radius does not load distant areas. Private chest permissions and wards are respected. Graves, dropped bags, carts and ship holds are excluded.

Use your mod manager's config editor while the game is closed, or a compatible in-game config editor. Loaded changes apply to the next relevant action; group changes also invalidate the cached membership rules. Editing the file directly while the game is running requires a config reload or restart.

Server configuration

Install the mod on your client to use your own settings in single-player or on a server without the mod. Install the same version on the server to override the gameplay settings of clients running the mod. Server settings are locked to server administrators by default. Keybinds and display preferences stay local, and your local gameplay values return when you disconnect. Players without the mod do not gain its features.

The server controls range, chest crafting/building, group routing and all group lists. Locate duration and both shortcuts stay local. 99 - Internal holds automatic migration markers.

Support

Valheim Plus: when its CraftFromChest section is enabled, ItemPull defers crafting, upgrades, building and requirement counts to Valheim Plus, using that mod's range and rules. Search, locate, pull, deposits, locks and grouping remain available. Disable that section and restart to use ItemPull's resource handling.

Containers and permissions: native chest access and ward permissions apply. Busy, denied, destroyed or out-of-range chests are skipped. Only loaded static chests are searched; graves, dropped bags, carts and ship holds are excluded. Inventory, ward and container mods can change the native behaviour used by ItemPull.

Manual installation

  1. Install BepInEx 5 for Valheim.
  2. Create BepInEx/plugins/Dyls123-ItemPull/ in the game installation or active mod-manager profile.
  3. Copy ItemPull.dll from the release ZIP into that folder.
  4. Keep only one copy of the DLL and launch the game to generate the config.

The versioned ZIP and Dyls123-ItemPull.zip use the same Thunderstore-compatible layout, with the DLL at the ZIP root. A mod manager installs the package and its declared dependencies automatically.

CHANGELOG

Changelog

0.5.1

  • Include CHANGELOG.md in both release packages so version history is available on Thunderstore.

0.5.0

  • Standardise README sections and numbered config categories.
  • Preserve existing configured values when moving sections.
  • Add optional server overrides for gameplay settings while keeping personal controls and display settings local.
  • Use a consistent Thunderstore-compatible package for all downloads.

0.4.1

  • Added support for Valheim Plus.

0.4.0

  • Thunderstore upload archive with root manifest, 256x256 icon, BepInEx dependency, documented installation paths.
  • Group sorting for Deposit All and the single-stack deposit shortcut: exact matches first, then nearest chests containing only the same group.
  • Master grouping toggle, separate shortcut toggle and optional biome mode (off by default) that replaces standard categories.
  • 20 editable standard groups, nine editable biome presets and five blank custom groups in the main config. Custom groups take priority; prefab IDs, wildcards and native item-type selectors are supported.
  • Recheck contents and current group rules after permission arrives; empty and mixed chests remain exact-item-only.
  • Deposit from personal inventory while a container is open; your own open chest keeps its reservation and uses its existing native access grant.
  • Retain client-only installation, lock protection and native inventory persistence.

0.3.0

  • Craft, upgrade and build with accessible chest resources using the same search radius.
  • Count nearby resources only for requirements; acquire native chest access before completing actions and consume personal stock before chest shortages.
  • Deposit All button beside ItemPull, targeting only already-matching chests and skipping locked, equipped and quest items.
  • Configurable item-lock shortcut, default Alt + middle-click, with gold [L] indicators and tooltips.
  • Locks persist through native serialization, moves, splits, merges and upgrades, and block both deposit methods.
  • Keep client-only installation; add separate config switches for chest crafting and building.

0.2.0

  • Default radius increased to 60 metres; Locate duration reduced to 4 seconds.
  • Previous defaults migrate once while custom settings are preserved.
  • Middle-click deposit for the hovered inventory stack, with a configurable shortcut.
  • Deposits only enter accessible nearby chests already containing the same item; empty/full/denied storage leaves remaining items in the inventory.
  • Native inventory wood panels, button textures, decoration and body fonts replace flat grey styling.
  • Client-only installation and vanilla chest access/transfer networking retained.

0.1.0

  • Inventory search with translated item names, totals, paging and a configurable radius.
  • Locate with temporary cyan chest outlines, quantities and distance labels.
  • Pull a chosen quantity or all matching items across nearby chests.
  • Native chest access exchange and slot transfers, permission checks, cancellation and partial-inventory handling.