HexQuickStackStorage

Inspired by Goldenrevolver's Quick Stack Store Sort Trash mod.

This mod adds Quick Stack, inventory sorting, chest sorting, trash management, item favorites, trophy auto storage, and ServerSync support.

The mod has been designed with multiplayer compatibility in mind. ServerSync is supported for selected gameplay-affecting configuration values.

I've only tested on a dedicated server with one player, so I have not tested multiplayer scenarios. Any multiplayer feedback is welcome.

Quick Stack Access Modes and Limitations

Quick Stack has two configurable container access modes:

• CharacterOwned - Only uses containers created by the current character (default).
• Accessible - Uses public containers the current character can access. Select this if you want to Quick Stack into any public container.

Ward-protected containers are only used when the character has access to the protected area.

Quick Stack also has a few limitations:

• Containers that are currently in use are skipped during nearby Quick Stack.
• Normal items are only moved to containers that already contain that item type.
• Empty containers are not used.
• Favorited, equipped, and hotbar items are ignored.
• Only items inside the normal player inventory are considered.
• A container must have enough stack space or an empty slot for at least part of the item.
• The configured access mode applies to nearby Quick Stack searches. Manually opened containers can still use the mod's stack and sort actions.

Trophy Auto Storage

Trophy auto storage can be enabled in the configuration.

Instructions

Quick Stack

Click the Q button in your inventory or use the configured Quick Stack keyboard shortcut (default P).

Quick Stack searches nearby eligible containers and moves matching inventory items into them.

For normal items, if a container already contains an item type, Quick Stack will fill existing stacks first and then use empty slots in that container if needed.

When trophy auto storage is enabled, trophies use trophy containers as described above.

Sort Inventory

Click the S button in your inventory to sort your normal player inventory.

Sorting will:

• Leave hotbar items in their current slots
• Leave equipped items in their current slots
• Leave favorited items in their current slots
• Consolidate compatible item stacks
• Sort the remaining inventory items

Sort Chests

When a supported chest or container is open, click the Sort button beneath the container inventory to sort it.

The Sort button is only shown for supported Valheim containers. Custom container inventories provided by other mods may not support sorting.

Automatic chest sorting can also be enabled in the configuration. When enabled, a supported container is sorted when successfully opened.

Favorite Items

Hold Left Control and Right Click an item to favorite or unfavorite that item type.

Favorited items have a gold border and:

• Cannot be Quick Stacked
• Will not be moved or consolidated when sorting your inventory
• Cannot be deleted

Favorites apply to the entire item type. For example, favoriting Wood Arrows causes all Wood Arrow stacks to be treated as favorites.

The Favorite modifier key can be changed in the configuration.

Delete Items

There are two ways to delete items.

Drag and Delete

Drag an item from your inventory, then click the trash icon.

Equipped, hotbar, and favorited items cannot be deleted.

Mark Items as Trash

Hold Left Shift and Right Click an item to mark or unmark that item type as trash.

Items marked as trash have a red border.

Click the trash icon to delete all currently marked trash items from your inventory.

Trash applies to the entire item type. Newly picked up items of the same type will also be treated as trash.

Equipped, hotbar, and favorited items cannot be marked as trash.

Marking an item as trash removes its favorite state.

The Trash modifier key can be changed in the configuration.

Favorite and Trash Storage

Favorite and trash selections are stored as text files in the BepInEx config directory:

• HexQuickStackStorage.favorites.txt
• HexQuickStackStorage.junk.txt

Each file stores one internal item name per line and is updated automatically when item states change.

Deleting either file clears the corresponding saved selections the next time the mod starts.

Multiplayer and ServerSync

HexQuickStackStorage includes ServerSync support.

The following settings are synchronized from the server:

• Quick Stack search radius
• Container access mode
• Automatic chest sorting
• Trophy auto storage

The server can also lock synchronized configuration values so connected clients use the server's settings.

Client-only settings such as keyboard shortcuts and inventory modifier keys are not synchronized.

Configuration

Configuration options include:

• Quick Stack search radius
• Quick Stack keyboard shortcut
• Container access mode
• Automatic chest sorting
• Trophy auto storage
• Trash modifier key
• Favorite modifier key
• Delete confirmation
• Server configuration locking

The Trash and Favorite modifier keys cannot use the same key.

Support

Discord support:

https://discord.gg/wU2FXD94v4

Source

GitHub:

https://github.com/guillenjgg/valheim-hex-quick-stack-store

Changelog

v1.4.3

Added

• Compiled against Valheim v1.0.16.

Changed

• Changed the container sort button from "Sort" to "S".
• Repositioned the container sort button to prevent it from overlapping the inventory grid.

v1.4.2

Added

• Added a tooltip explaining Quick Stack is unavailable while a container is open.

Fixed

• Fixed the Quick Stack keyboard shortcut not working while movement or other unrelated keys are held.
• Quick Stack is now disabled while a container is open to avoid conflicting with the container's Place Stacks action.

v1.4.1

Added

• Compiled against Valheim v1.0.14.

Fixed

• Fixed Accessible container access mode allowing Quick Stack to use world-generated containers.
• World-generated containers are now excluded using Valheim's player-placed container detection.
• Fixed compatibility with custom container mods that use Valheim's Place Stacks functionality.
• Fixed the container Sort button appearing on unsupported custom container inventories.

v1.4.0

Added

• ServerSync integration.
• Configuration option to auto stack trophies.

v1.3.0

Added

• Added a confirmation dialog before deleting items.
• Added a configurable option to enable or disable delete confirmation.
• Added a "Don't show this confirmation again" checkbox to the delete confirmation dialog.
• Added a confirmation message when items are successfully deleted.

Changed

• The delete confirmation dialog can be dragged to reposition it.
• Delete confirmation is skipped when it has been disabled through the configuration or confirmation dialog.
• Item deletion messages are now displayed in the center of the screen.
• The "Items Deleted" message is only shown when at least one item was actually deleted.

v1.2.0

Added

• Added configurable container access modes for Quick Stack.
• Added CharacterOwned mode to only Quick Stack into containers created by the current character.
• Added Accessible mode to Quick Stack into any public container the character can access.

Changed

• Quick Stack now respects ward-protected container access.
• Quick Stack now supports stacking into carts.
• The vanilla Place Stacks and hold-to-stack actions now respect favorited items.

Fixed

• Fixed Quick Stack failing on containers due to Valheim's restricted container access methods.
• Fixed Quick Stack failing on carts due to restricted ZNetView access.
• Fixed Quick Stack failing when targeting an already-open container.
• Fixed Place Stacks moving favorited items into containers.

v1.1.0

Added

• Compiled with Valheim v1.0.12.
• Added the ability to favorite item types.
• Favorited items are protected from quick stacking, sorting, and deletion.
• Favorite selections persist between game sessions.
• Added a configurable Favorite modifier key.
• Added a Sort button to opened chests.
• Added an option to automatically sort chests when opened.

Changed

• Auto chest sorting is now a configuration option and is disabled by default.
• Quick Stack keyboard shortcut now works while the inventory is open.
• Inventory sorting now consolidates compatible item stacks.
• Hotbar, equipped, and favorited items remain in their current slots when sorting.

Fixed

• Fixed chest auto-sorting not respecting its configuration setting.
• Fixed Quick Stack not working while the inventory is open.
• Fixed Quick Stack not partially transferring an item stack when a chest only has room for part of the stack.

v1.0.1

Fixed

• You can now delete items marked as trash by clicking the trash icon.

v1.0.0

• Initial release