The Vault

The Vault

(v3. 3. 2)

Sun Haven BepInEx mod: per-character vault, encrypted saves, HUD, auto-deposit—with shops and in-game costs (keys, etc.) reading and spending vault balances via your bag when the game uses inventory checks.

Your vault save: Normal updates are not meant to erase your vault. Per-character balances live in this mod's encrypted vault data; when the save format changes, maintainers intend to migrate old data forward. If a release cannot keep compatibility, it will be called out loudly in the README, store descriptions, and changelog — with backup steps. See SAVE_COMPATIBILITY.md in the mod package for the maintainer policy.

Ship bothTheVault.dll and TheVault. Abstractions.dll together in BepInEx/plugins/TheVault (or the same folder). Dependent mods may reference only the abstractions assembly.

Features

• []Per-character encrypted vault (VaultSaveSystem, VaultManager)[/]

  []Auto-deposit, shop hooks, inventory hooks for vault-backed keys/currency, on-screen HUD[/]

  []Secret Gifts tracking in SecretGifts.dat[/]

  []Custom tab and runtime currency registration for other mods (VaultIntegration / TheVault. Abstractions)[/]

  ---

  Usage

  • []Main window: IMGUI vault UI — Ctrl+V or F8. HUD hides while the window is open.[/]

    []F7: Toggle HUD.[/]

    []Select a row, enter a quantity, then Withdraw (vault → bag) or Deposit (bag → vault). Status text under the buttons reports success or errors.[/]

    [] Density: Normal, Compact, or Minimal. CompactMode still narrows the bar when Density is Normal. In-game Settings tab shows HUD density and compact toggle.[/]

    ---

    Full vault inspector

    Enable FullVaultInspector = true in BepInEx/config/com.azraelgodking.havendevtools.cfg, or in Haven Dev Tools (F11) → Azrael's Mods → The Vault. The vault Settings tab shows whether this mode is on (not stored in thevault.cfg).

    When enabled:

    • []Tabs list every defined currency, including 0 balance.[/]

      []Debug tab — text dump of all vault stores (seasonal, keys, specials, custom).[/]

      []HUD lists all seasonal / key / special slots and all custom ids (including zeros).[/]

      ---

      Custom currencies (other mods)

      • []Dependency: so your mod loads after The Vault.[/]

        []After TheVault. Api. VaultIntegration. IsVaultReady, call VaultIntegration. RegisterCustomCurrency(id, displayName, gameItemId, enableAutoDeposit).[/]

        []id: short key, lowercase letters, digits, underscore only (max 64). Do not include custom_ prefix; storage uses custom_{id}.[/]

        []gameItemId: Sun Haven item id for withdraw / optional auto-deposit; -1 for balance with no inventory item.[/]

        []Orphan balances: If a mod is removed, totals may remain under CustomCurrencies — enable full inspector → Debug tab to see raw keys; re-register the same short id to restore the Custom tab.[/]

        []Hooks: VaultManager exposes OnVaultLoaded and OnCurrencyChanged. Subscribe via Plugin. GetVaultManager() after the vault exists.[/]

        []Thin API: Reference TheVault. Abstractions.dll. At runtime use TheVault. Modding. VaultModApiBridge. Instance (IVaultModApi: IsVaultReady, RegisterCustomCurrency).[/]

        ---

        Requirements

        • []BepInEx 5.x for Sun Haven[/]

          []Sun Haven[/]

          Installation

          • []Copy TheVault.dll and TheVault. Abstractions.dll into the same plugins folder (e.g. plugins/TheVault/).[/]

            []Launch the game[/]

            Build (source)

            dotnet build TheVault/TheVault.csprojBoth DLLs should land next to each other under plugins. Distribute both to players.

            ---

            Links

            • []Nexus Mods[/]

              []Discord - bugs & discussion[/]

              Changelog — 3. 0. 2

              Vault+bag duplication fix (auto-deposit only on player bag); curr