RuneVault - Virtual Bank for Valheim

Overview

RuneVault is a Valheim mod designed to provide players with a "virtual bank" for building materials. It allows players to deposit, withdraw, and manage building resources globally, rather than relying solely on physical inventory or chests. The mod aims to streamline resource management for construction and crafting, making large-scale building projects more convenient.

Media

Here are some screenshots of RuneVault in action:

RuneVault Structure

RuneVault UI

RuneVault Quantity Selection

Features

• Per-Player Virtual Bank: Each player has their own bank, stored persistently via ZDOs.
• Configurable Allowed Items: Default accepted items include crafting/building materials, extensible via YAML config.
• Custom RuneVault Prefab: A small runestone with a simple crafting recipe
• Intuitive UI: MerchantNPCs-like interface with search functionality.
• Building & Crafting Integration: Seamlessly integrates with Valheim's building and crafting systems, as well as many other modded crafting systems.
• Multiplayer Support: Full synchronization in multiplayer environments.
• Debug Tools: Special debug UI and testing tools (only available in debug mode).

Installation

1. Install BepInEx if you haven't already.
2. Install Jötunn (required dependency).
3. Download the RuneVault mod and place the DLL in your BepInEx/plugins folder.
4. Launch Valheim and enjoy your new RuneVault!

Usage

Building a RuneVault

1. Craft a RuneVault using the vanilla hammer at a workbench.
2. Required materials: 50 stone, 20 thistle, 5 surtling cores.

Using the RuneVault

1. Approach a RuneVault structure (within 5 units) to interact with its UI.
2. Interact with it (E key by default) to open the RuneVault UI.
3. Use the interface to deposit or withdraw materials.
4. Materials in your RuneVault will automatically be used for building and crafting when you're within 35 units of any RuneVault.

Configuration

The mod creates a YAML configuration file at BepInEx/config/RuneVault/RuneVaultItems.yaml. You can edit this file to customize which items can be stored in the RuneVault.

Configuration Options

• StrictYamlFiltering: When set to true (default), only items explicitly listed in the YAML file are allowed, bypassing property checks. Set to false to enable additional property-based filtering.
• DebugMode: When enabled, provides detailed logging about item filtering decisions.

Known Edge Cases

• Raspberry and Cloudberry: These items have special handling. If anyone knows how to get these added, please reach out!
• Modded Items: Items from mods that aren't loaded when RuneVault initializes may not be recognized properly.
• UI Refresh: If deposited items don't immediately appear in the UI, close and reopen the vault to refresh the display.

Changes to yaml configuration should take effect upon yaml save. If not, restart the game.

Features in Detail

Virtual Bank System

The RuneVault bank allows you to store building materials and other configured items without taking up inventory space. The bank is per-player, so each player has their own separate storage.

Building and Crafting Integration

When near a RuneVault, the game will automatically check for materials in your bank when building or crafting. If you don't have enough materials in your inventory but have them in your bank, they will be used from the bank.

UI Features

• Search: Find specific items by name
• Quick Deposit/Withdraw: Buttons for common quantities (x1, x10, x50, x100)
• Deposit All: Quickly deposit all allowed items from your inventory (excluding equipped and hotbar items)

Note: If deposited items don't immediately show up in the UI, close the UI (press Escape) and then reopen it to refresh the item list.

Multiplayer Compatibility

RuneVault is fully compatible with multiplayer and includes version checking to ensure all players have compatible versions of the mod.

Debug Mode

For mod developers or troubleshooting, RuneVault includes a debug mode that can be enabled in the config file. When enabled, additional UI elements and testing tools become available:

• Debug panel with bank information
• Test suite for verifying functionality
• Tools to add/remove items directly to/from the bank

Mod Compatibility

RuneVault is designed to be compatible with most other Valheim mods. It includes checks for potential conflicts with other inventory or crafting mods.

Note: Mods that affect containers/chests won't interact with RuneVault since it is not technically a container. These mods should still work alongside RuneVault, but they won't affect its interaction, storage system, or UI.

Support and Feedback

If you encounter any issues or have suggestions for improvement, please report them on the Ruijven Discord server, runevault channel: https://discord.gg/qGf5FdqhVC

Support the Mod

If you enjoy this mod and want to support its development, consider joining our community!

Join Ruijven Discord

Credits

• Built with Jötunn, the Valheim Library.
• Special thanks to the Valheim modding community for their support and resources.

Your feedback helps shape the future of RuneVault!