ZenDistributor

Distribute the contents of your cart or ship into nearby chests with visual feedback.

Features:

• Unload your cart into nearby chests.
• Unload your ship into nearby chests or carts.
• Visual feedback to see where your items went.

Improved Cart Handling:

• Ignore upside down: Can attach even if it's upside down.
• Increased attach distance: Makes carts easier to connect.
• Quickly detach by attacking, crouching, or doing other common actions.

The idea behind this mod is to make unloading your cargo easier. There are other mods that allow you to unload your player inventory directly. However, I felt that was over optimized and trivialized gameplay leading to a loss of immersion from excessive automation. This mod rewards the player for using carts and makes distribution a deterministic process.

Additionally, you can use the Distributor to move items directly from your ship into a nearby cart or chest on the shore.

This mod aims to create a balance where immersion is not lost from full automation yet still allows for quickly unloading your cargo in one button press.

The manual selection is important for preserving the atmosphere and tone of the game's experience and encourages the player to use Carts for hauling large quantities of items.

Best When Combined With...

• ZenHoverItem Easily view the content of containers and other objects in the world.
• ZenSign See the amount of each item you have in your hoard.
• ZenPath No stamina use on paved roads, half stamina use on dirt paths.

Known Issues

Some mods apply slot favorites that prevent stacking from certain slots. Sometimes these mods do not check that the slot they are protecting is inside the player's inventory. In those cases they will cause ZenDistributor to fail to distribute protected slots. If you are experiencing this issue, please disable the slot favorite features in conflicting mods and talk to the mod author about validating the favorites. They need to make sure the slot is in the player's inventory, not just a general X/Y position on any container's inventory.

Client / Server Requirements

NOTE: Technically it is not required on the server. However, if it is installed on the server then it will force all clients to have it installed as well. This is to enable two modes of usage:

1. Dedicated server admins can put the mod on the server to enforce all clients to have the mod installed and sync admin configs.
2. Trusted friends can agree to run the same mods and connect through a vanilla dedicated server with no enforcement but with locked admin configs.

Client Only

This mod operates entirely client side. That means you can connect to any vanilla server with this mod installed. Other players do not need to have the mod installed.

NOTE: If you host a game session with this mod installed then it will be considered to be installed on the server since your session is the server. Therefor, all clients will be required to have it. If you don't want to require all players to have this mod then you will need to host your game in a dedicated server. You can easily download and run the Valheim Dedicated Server from Steam or host one in the cloud.

Extend Functionality with Additional ZenMods

• ZenHoverItem: Peek into chests and everything else with quick visual feedback.
• ZenSign: Organize your hoard, view the amount of every item in your warehouse, and quickly find it.
• ZenRedecorate: Move chests and other things around without destroying them.
• ZenItemStand: Item Stands and Armor Stands behave like containers. Quickly swap your gear.

Improve Your Experience

CORE MODS

The full collection of all Zen MODS:

• Radically improved QoL
• Incredible performance
• Pre-configured
• 100% Gamepad support
• Spectacularly immersive

Enjoy!

Sample Config File

## Settings file was created by plugin ZenDistributor v1.0.0
## Plugin GUID: ZenDragon.ZenDistributor

[Cart]

## [Admin] When true the cart attaches to the player much more easily. (Vanilla: false)
# Setting type: Boolean
# Default value: true
Snap To Player = true

## [Admin] Minimum distance the player must be from the cart in order to attach it. (Vanilla: 2)
# Setting type: Single
# Default value: 7
# Acceptable value range: From 1 to 10
Attach Distance = 7

## [Admin] If true the cart will not prevent attach when upside down. (Vanilla: false)
# Setting type: Boolean
# Default value: true
Ignore Upside Down = true

[General]

## [Admin] Comma separated list of prefabs that can be used as a distribution source.
## They must have a Container component or they will not work.
# Setting type: StringList
# Default value: Cart, Karve, VikingShip, VikingShip_Ashlands
Allowed Distributor Prefabs = Cart, Karve, VikingShip, VikingShip_Ashlands

## [Admin] Only distribute into these container prefab names.
## They must have a Container component or they will not work.
# Setting type: StringList
# Default value: piece_chest_wood, piece_chest, piece_chest_blackmetal, piece_chest_barrel, piece_pot1, piece_pot2, piece_pot3, Cart
Allowed Container Prefabs = piece_chest_wood, piece_chest, piece_chest_blackmetal, piece_chest_barrel, piece_pot1, piece_pot2, piece_pot3, Cart

## [Admin] How far away to search for containers from the cart's location
# Setting type: Single
# Default value: 10
# Acceptable value range: From 3 to 25
Max Distribution Range = 10

## [Admin] Highlight duration for chests that had items distributed into them (in seconds)
# Setting type: Single
# Default value: 5
# Acceptable value range: From 0 to 30
Higlight Duration = 5

Like My Mods? Donations Welcome

Bitcoin

v1.1.0

• add help info to Compendium
• recompile for Zen.ModLib v1.10.0

v1.0.3

• updated up README to reflect that ships are now allowed to be used as distribution sources and carts as targets.
• no code changes.

v1.0.2

• BUGFIX: carts were sinking instead of floating due to a bug introduced when carts were allowed to be added as valid distribution targets. Technical details: Old code was resetting layer masks on distribution targets so that they could be found via OverlapSphere checks. This adjustment to layer masks accidentally caused the Floating collider on carts to stop working. Carts would sink because they didn't know they were in the water. New code uses the static Piece list and does not perform a layer collision check to find valid distribution targets. Therefore, layer mask adjustments are no longer needed. Carts no longer sink.
• Added a check to make sure the cart is not in use before attempting to move contents to it from a ship.

v1.0.1

• can now distribute directly from a Ship into a Cart that DOES NOT have the same items in it. This includes empty carts as the distribution target from ships as well.
  • this feature only works one-way: from Ships to Carts to avoid confusion and misplacement.

v1.0.0

• add the ability to distribute from ship to cart.
• changed default configs to distribute from ship to containers on shore, including carts.
• recompile for Zen.ModLib v1.7.0

v0.2.7

• changed the log level for prefabs flagged in v0.2.6 to Warning instead of silent Info. It should be noted but can be ignored.

v0.2.6

• fix: remove the error message when prefab is not in ZNetScene when setting layers, instead log the error silently and skip it. This can be caused by WackyDB creating new prefabs after ZenDistributor.

v0.2.5

• fix: apply the correct layer mask to pieces which do not have the "piece" mask applied to their colliders.

v0.2.4

• removed Attack from the list of actions that can quickly detach the cart. you can still block to quickly detach. This way you can clear shrubs or weak animals without detaching.
• compiled for Valheim 0.221.4, Call to Arms

v0.2.3

• added a config option to list prefabs that can be used as distributors. Hint: You can list all the ship prefabs if you want to unload from ships more easily. However, they are not included by default because it discourages building docks.

v0.2.2

• same as v0.2.3 (forgot to update readme)

v0.2.1

• moved highlight color config to Zen.ModLib
• moved area search code to Zen.ModLib
• updated to use Zen.ModLib v1.2.5

v0.2.0

• updated for Zen.ModLib v1.2.0
• recompile for BepInEx v5.4.2332
• recompile for JVL v2.26.0

v0.1.7

• add a "Known Issues" section to the readme. no code changes.

v0.1.6

• small change to work better with MultiUserChest

v0.1.5

• fix ZDO ownership issues in multiplayer games.

v0.1.4

• update readme, no code changes.
• update Zen.ModLib dependency to v1.1.24

v0.1.3

• disable distribution processing if no allowed containers are defined in the configs. (provides an easy way to disable the distribution mechanism while still retaining cart QoL handling improvements)
• check for warded containers before distribution.

v0.1.2

• updated readme and description, no code changes.

v0.1.1

• moved cart handling code from ZenWorldSettings into this mod.

v0.1.0

• Initial release