Quick Stack Store Sort Trash Restock
Quick Stacking, Sorting, Trashing and more in one cohesive package
Last updated | a month ago |
Total downloads | 348074 |
Total rating | 100 |
Categories | Hildir's Request Update Ashlands Update |
Dependency string | Goldenrevolver-Quick_Stack_Store_Sort_Trash_Restock-1.4.11 |
Dependants | 912 other packages depend on this package |
This mod requires the following mods to function
denikson-BepInExPack_Valheim
BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.
Preferred version: 5.4.2202README
This mod attempts to be the one stop inventory management mod, combining various features into one cohesive package, while adding UI elements in addition to hotkeys as well as compatibility for Equipment and Quick Slot mods and localization.
This mod allows you to
- quickly stack your items into the current or nearby chests
- quickly restock the items you want (like food and ammo) from the current or nearby chests
- store all items into the current chest (complementary to the 'take all' button)
- sort the player inventory or the current chest by configurable criteria
- trash the currently held item or quick trash all previously trash flagged items in the player inventory
All these features are controlled by the option to favorite items or slots similar to games like Terraria.
There is also an extensive configuration system, that applies changes immediately. I highly recommend using an in-game Configuration Manager mod. I put a lot of effort into the descriptions of the config options, so if you have any questions, please read them.
1 - Favoriting
Favoriting is the main draw to combine all these features into one mod. By holding the Favoriting Key (default: Alt) or by using a new button, you can left click on an item to favorite it, or right click to favorite the slot it is in. This prevents most features of this mod from affecting it. No accidental quick stacking, sorting, storing or trashing. The favoriting state is shown with a custom colored border around the slot.
If you are actively using Favoriting, I recommend changing the config option 'OverrideHotkeyBarBehavior' in the 'General' section from 'NeverAffectHotkeyBar' to 'UseIndividualConfigOptions'.
2.1 - Quick Stacking
You are probably already familiar with Quick Stacking. With one button press, every non favorited item possible is put into the current or nearby chests that already contain this kind of item.
This implementation is based on the original Quick Stack mod by damnsneaker, who gave me permission. This mod has a smarter algorithm for accessing multiple containers than the original (even if it's not threaded like Quicker Stack, but that prevents the issues that mod is currently facing).
2.2 - Restocking
Restocking is like Quick Stacking but in reverse. Quickly refill your arrows, your food or your one emergency stack of wood from the current or nearby chests. With one button press, restocking tops off (or optionally partially refills) the stack size for each item in your inventory that you want to restock, which can easily be configured (for example based on item type or favoriting status).
2.3 - Area Quick Stacking and Restocking
This mod uses improved checks for multiplayer compared to most Quick Stack mods, so you can't quick stack into or restock out of chests that are currently opened by someone else. Still, this mod cannot wait for network requests when blocking chests as in use (then everyone would need the mod installed), so it does have its limitations, especially with high latency. The ship container has even been excluded from area stacking as a precaution, as lots of players open and close it in rapid succession while they wait for their friends to set sail.
If you want to get rid of those limitations, this mod is compatible with the mod Multi User Chest. If you are not using it, then area quick stacking and restocking in multiplayer is disabled by default, but you can simply enable the config setting 'AllowAreaStackingInMultiplayerWithoutMUC' if you are comfortable with it.
All area quick stacking and restocking config settings are also server synced, but it is not required for every user to have the mod installed.
3 - Store and Take All
This simply adds a 'Store All' button to the chest overlay which stores all non favorited items (it can even store and unequip equipped items if you configure it that way).
The logic of the 'Take All' button of chests (excluding tomb stones for compatibility) was also updated to work complementary and symmetrically to 'Store All'.
4 - Sorting
Sorting is based on the popular mod Inventory Sorting by end360 (with permission). It adds a 'sort inventory' and 'sort container' button that respects favoriting.
There are various different sort criteria to choose from:
- category (bunches up similar item types into categories like armor, weapons, etc)
- internal name
- translated name
- weight
- value
Ties are always broken by internal name, quality and stack size. You can also sort automatically when opening the inventory or a container.
5 - Trashing and Quick Trashing
Trashing is based on the amazing mod Trash Items by virtuaCode (with permission). It adds a trash can UI element to the inventory screen to quickly trash any non favorited item.
This mod also adds Quick Trashing. By holding the Favoriting Key while you attempt to trash an item, you instead 'trash flag' this kind of item, similar to favoriting. When you click on the trash can without holding an item, an option to Quick Trash will appear allowing to trash all trash flagged items in your inventory.
If you are scared of trashing the one stack of an item that you usually consider trash flagged, consider putting it in a favorited slot.
Compatibility
- Due to the continued efforts of the author MSchmoecker, the newest version of 'Multi User Chest' and my mod are now compatible. Be aware that sorting a container, that someone else is already using, only works if that user also has my mod installed.
This mod has explicit compatibility for the following Equipment and Quick Slot mods:
- My mod will respect both the equipment slots and the quick slots, and intentionally allows restocking the quick slots. 'Take All' will put items into the quick slots though, but that is intended functionality of 'Comfy Quick Slots'.
Azu Extended Player Inventory:
- My mod will respect both the equipment slots and the quick slots, and intentionally allows restocking the quick slots. The buttons from my mod will move to not overlap if the separate equipment slot UI is enabled.
Odins QOL and Odins Extended Inventory:
- My mod will respect both the equipment slots and the quick slots, and intentionally allows restocking the quick slots. The buttons from my mod will move to not overlap if the separate equipment slot UI is enabled.
Aedenthorn's Extended Player Inventory:
- This mod behaves identically to AzuEPI, OdinsQOL and OdinsExtendedInventory, because they used Aeden's work as a base. If you use this, be sure to download this mod from Nexus and not from Thunderstore, as those are unofficial irregularly updated versions.
RandyKnapp's Equipment and Quick Slots:
- The slots from this mod are not actual inventory slot, so my mod cannot affect them in any way (which is good). Due to that, restocking the quick slots is not possible though. The buttons from my mod will move to not overlap with the equipment slot UI and while using a chest the small Quick Stack and Restock buttons are hidden if you have quickslots enabled (because there is no room for them).
- My mod will respect the slots this mod reserves for the quiver feature (all 16 of them, even if it only uses 3), and intentionally allows restocking the arrows. 'Better Archery' also changes how item adding, including 'Take All', works, so please be aware that that is not my doing.
Incompatibility
Stacks of items with custom data, like from Jewelcrafting, Blacksmithing or Cooking, are excluded from getting merged by sorting or getting restocked, but otherwise behave normally.
The container buttons from this mod are intentionally hidden when using certain custom containers (like the jewelry bag from Jewelcrafting), because my mod cannot affect them anyway.
The UI from this mod is currently incompatible with Project AUGA, but compatibility is being worked on. Hotkeys should work though.
This mod is incompatible with Trash Items because it is included in this mod.
This mod cannot detect item drawers from KGvalheim's ItemDrawers (unlike the item drawers from makail's ItemDrawers in the past).
Localization
This mod includes a translation system for all ingame display texts (not the config menu). Currently English, Chinese, Russian, French, Brazilian Portuguese, Polish, Swedish, Korean and Italian are supported.
For minor edits, you can override any display text in the config. If you want to translate everything to your native language, you can take the QuickStackStore.English.json
as a template and name your file QuickStackStore.<language>.json
, where <language>
needs to be the folder name of the base game for your language. When you are done or need help, please reach out to me, so I can add it to the mod for everyone.
Thank you to everyone who provided a translation:
The Chinese translation was provided by Tiomer.
The Russian translation was provided by Opik7.
The French translation was provided by cyouinlan.
The Brazilian Portuguese translation was provided by kaiqueknup and updated by the YggBrasil team.
The Polish translation was provided by ViRooz.
The Swedish translation was provided by DeathDaisy.
The Korean translation was provided by hanawa07.
The Italian translation was provided by Marcuz08.
The Ukrainian translation was provided by cawa-93.
Source code available on github: https://github.com/Goldenrevolver/QuickStackStore
If you want to support me, check out my ko-fi: https://ko-fi.com/goldenrevolver