Player Vaults

Last updated Oct 28, 2026

Player Vaults

Extra personal storage chests (playervaults) with a vault picker GUI, admin tools, and optional vault autopickup.

Module: playervaults in modules.yml
Config: playervaults.yml
Data: data/storage/vaults/{uuid}.yml
Defaults: Default playervaults.yml · Config Reference.

Player how-to

  1. Open vaults: /sa vault (picker) or /sa vault open [n]. Alias: /sa pv when shipped overrides are present.
  2. Check fill: /sa vault list.
  3. Autopickup (if permitted): /sa vault autopickup to cycle, or set off / direct / overflow and vault <n> as target. Right-click a vault in the picker to set the autopickup target; hopper / F cycles mode.

Staff how-to

  1. Open another player's vault: /sa vaultadmin open <player> [n] (read-only without soapsadmin.vaultadmin.edit).
  2. Clear: /sa vaultadmin clear <player> [n]. Summary: /sa vaultadmin info <player>.
  3. Grant tier perms: soapsadmin.vault.limit.N, soapsadmin.vault.rows.N, autopickup nodes. Ops alone do not unlock extra vaults.
  4. Edit playervaults.yml → /sa reload playervaults.

Commands

Command Permission Description
/sa vault soapsadmin.vault Open picker (or vault #1 if you only have one)
/sa vault gui soapsadmin.vault Open vault picker
/sa vault open [n] soapsadmin.vault Open vault n
/sa vault list soapsadmin.vault Chat summary + fill bars
/sa vault autopickup soapsadmin.vault.autopickup Cycle mode
/sa vault autopickup <off|direct|overflow> mode perms Set mode
/sa vault autopickup vault <n> soapsadmin.vault.autopickup Target vault for pickup
/sa vaultadmin open <player> [n] soapsadmin.vaultadmin Open another player's vault
/sa vaultadmin clear <player> [n] soapsadmin.vaultadmin.clear Clear a vault (closes viewers first)
/sa vaultadmin info <player> [page] soapsadmin.vaultadmin Show vault summary (paginated)

Edit other players' vaults requires soapsadmin.vaultadmin.edit. Without it, admin open is read-only ([view] in the title).

Picker GUI

Left-click a vault to open it. Right-click sets the autopickup target. Hopper / F cycles autopickup mode when permitted.

Aliases (customcommands)

Shipped defaults:

  • /sa pv / /sa playervault → vault
  • /sa pva / /sa playervaultadmin → vaultadmin

Permissions (tiers)

Regular players with soapsadmin.vault get one vault (default-vault-count). Extra vaults require an explicit numbered permission: ops / * wildcards alone do not unlock more.

Permission Effect
soapsadmin.vault.limit.N Max vaults (highest explicit N wins; else default-vault-count)
soapsadmin.vault.rows.N Chest rows 1–6 (highest explicit N wins; else default-rows)
soapsadmin.vault.autopickup Enable vault autopickup feature
soapsadmin.vault.autopickup.direct Allow direct mode
soapsadmin.vault.autopickup.overflow Allow overflow mode

Shipped examples: limit.2 / 3 / 5 / 10, rows.4 / 5 / 6 (all default false).

Example higher-tier kit: grant limit.3, rows.6, autopickup, autopickup.direct, autopickup.overflow.

Autopickup modes

Separate from /sa autopickup (player inventory magnet).

Mode Behavior
off Disabled
direct Nearby drops go straight into the target vault
overflow Fill player inventory first; leftovers go into the vault

Radius and tick interval come from playervaults.yml. Pickup skips a vault that is currently open (avoids desync). Blacklisted materials and player item-filter entries are ignored. Blacklisted items are rejected on place (not only on close).

Item fidelity

Vault contents are stored with ItemStack.serializeAsBytes() (Base64 in YAML), so custom NBT, enchantments, attributes, PDC, and similar metadata survive restarts.

Config keys (playervaults.yml)

Key Default Effect
default-vault-count 1 Vaults when no vault.limit.N
default-rows 3 Chest rows when no vault.rows.N
title Vault #{vault} · {player} MiniMessage title ({player}, {vault})
open-sound BLOCK_CHEST_OPEN Open sound (Bukkit name, or none)
open-sound-volume 0.45 Volume
open-sound-pitch 1.05 Pitch
blacklist [] Materials that cannot be deposited
autopickup.radius 3.0 Pickup radius
autopickup.interval-ticks 10 Scan interval
autopickup.default-mode off Mode for new players (off / direct / overflow)
autopickup.default-vault 1 Default target vault number

Reload: /sa reload playervaults

Still stuck? Ask about this page