NexaVaults Documentation

Main runtime settings, license, modules, limits, storage and feature behavior.

# ...
# Short documentation excerpt from config.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
license-key: "LICENSE"

vaults:
  default-size: 54
  default-max-vaults: 3
  permission-mode: HIGHEST_INCLUDES_PREVIOUS
  show-locked-vaults: true
  open-cooldown-seconds: 1
  delete-confirmation-seconds: 15
  save-on-close: true
  save-on-shutdown: true
  selector-page-size: 21
  selector-item-amount-mode: VAULT_NUMBER
  default-type: default

features:
  buy: true
  upgrade: true
  renew: true
  sharing: true
  transfer: true
  community-vault: true
  search: true
  history: true
  sorting: true
  metadata-editing: true

safety:
  prevent-concurrent-open: true
  sanitize-on-save: true
  blacklist-mode: DISABLED
  whitelist-items: []
  blacklist-items:
    - SHULKER_BOX
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/config.yml to review every setting.
# ...

Plugin-specific YAML settings used by this product.

# ...
# Short documentation excerpt from vault-types.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
vault-types:
  default:
    display-name: "<gold>Default Vault</gold>"
    size: 54
    price: 0.0
    currency: VAULT
    share-limit: 3
    expires-after-days: -1
    interaction-fee: 0.0
    recurring-rent: 0.0
    recurring-rent-interval-days: 30
    mode: NORMAL
  premium:
    display-name: "<gradient:gold:yellow>Premium Vault</gradient>"
    size: 54
    price: 25000.0
    currency: MONEY
    share-limit: 6
    expires-after-days: -1
    interaction-fee: 0.0
    recurring-rent: 0.0
    recurring-rent-interval-days: 30
    mode: NORMAL
  seasonal:
    display-name: "<gradient:aqua:white>Season Vault</gradient>"
    size: 18
    price: 50000.0
    currency: MONEY
    share-limit: 0
    expires-after-days: -1
    interaction-fee: 0.0
    recurring-rent: 0.0
    recurring-rent-interval-days: 30
    mode: CLAIM_AFTER_RESET
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/vault-types.yml to review every setting.
# ...

# ...
# Short documentation excerpt from messages.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
prefix: "<gray>[<gold>NexaVaults</gold>]</gray> "
player-only: "<red>Only players can use this command.</red>"
player-not-online: "<red>That player must be online.</red>"
no-permission: "<red>You do not have permission.</red>"
invalid-number: "<red>That vault id is invalid.</red>"
invalid-usage: "<red>Invalid command usage. Check the command format and try again.</red>"
command-error: "<red>That command could not be completed. Check console for details.</red>"
selector-open-command: "<yellow>Use <gold>/vault</gold> to open the selector.</yellow>"
clear-command-renamed: "<yellow>Use <gold>clear</gold> instead of <gold>delete</gold>.</yellow>"
vault-opened: "<green>Opened vault <yellow>%vault%</yellow>.</green>"
open-cooldown: "<red>Please wait <yellow>%seconds%s</yellow> before opening another vault.</red>"
vault-saved: "<green>Saved vault <yellow>%vault%</yellow>.</green>"
vault-deleted: "<green>Cleared vault <yellow>%vault%</yellow>.</green>"
delete-confirm: "<yellow>Run the same clear command again within %seconds%s to confirm.</yellow>"
vault-created: "<green>Created vault <yellow>%vault%</yellow>.</green>"
vault-not-found: "<red>Vault <yellow>%vault%</yellow> does not exist.</red>"
vault-already-exists: "<red>The target player already has that vault number.</red>"
vault-locked: "<red>That vault cannot be opened right now.</red>"
vault-in-use: "<red>That vault is already open elsewhere.</red>"
vault-slot-locked: "<red>That vault slot is locked. Unlock it with permissions or your rank.</red>"
vault-open-blocked: "<red>Vault opening is currently locked by an administrator.</red>"
vault-locked-self: "<red>You already have that vault open.</red>"
vault-list-entry: "<gray>-</gray> <gold>Vault %vault%</gold> <gray>(%used%/%size%)</gray>"
vault-renamed: "<green>Renamed vault <yellow>%vault%</yellow> to <yellow>%name%</yellow>.</green>"
vault-described: "<green>Updated description for vault <yellow>%vault%</yellow>.</green>"
vault-icon-updated: "<green>Updated icon for vault <yellow>%vault%</yellow>.</green>"
vault-pin-updated: "<green>Toggled pin state for vault <yellow>%vault%</yellow>.</green>"
vault-category-updated: "<green>Updated category for vault <yellow>%vault%</yellow> to <yellow>%category%</yellow>.</green>"
share-updated: "<green>Shared vault <yellow>%vault%</yellow> with <yellow>%player%</yellow> as <yellow>%role%</yellow>.</green>"
share-removed: "<green>Removed <yellow>%player%</yellow> from vault <yellow>%vault%</yellow>.</green>"
share-self: "<red>You cannot share a vault with yourself.</red>"
share-not-found: "<red>That player does not have access to this vault.</red>"
reload-complete: "<green>NexaVaults configuration and menus reloaded.</green>"
search-header: "<gold>Search results for:</gold> <yellow>%query%</yellow>"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/messages.yml to review every setting.
# ...

Purpose: Provides economy withdrawals, deposits, prices, banks or metadata through Vault.

Troubleshooting: If balances, rewards or banks do not work, confirm Vault has an active economy provider and that no economy plugin loads after this product.

1. Install Vault and one compatible economy or permission provider.
2. Restart the server and confirm Vault reports a provider in console.
3. Enable prices, banks, rewards or currency features that depend on Vault.
4. Test one deposit and one withdrawal with a non-op account.

Purpose: Registers or consumes PlaceholderAPI values for scoreboards, formats and external displays.

Troubleshooting: If values stay blank, reload expansions and verify the identifier exactly matches the placeholder shown in this docs page.

1. Install PlaceholderAPI or the listed placeholder provider.
2. Install required expansions when the provider uses external expansions.
3. Use the exact placeholder identifiers documented in this page.
4. Reload the display plugin after changing scoreboard, tablist, menu or chat format files.

Purpose: Synchronizes runtime state between servers in a network setup.

Troubleshooting: If sync fails, verify server ids are unique, secrets match and the Redis/proxy channel is reachable from every server.

1. Configure a unique server id for every server in the network.
2. Set the same secret/channel values on every connected server.
3. Start Redis or the proxy messaging layer before testing cross-server state.
4. Test the same player workflow on two servers and watch for sync warnings.

Purpose: Provides persistent storage for player data, stats, transactions, vaults or network state.

Troubleshooting: If storage fails, copy the first SQL error, then verify credentials, database permissions, driver availability and firewall access.

1. Create the database and user before enabling SQL storage.
2. Enter host, port, database, username and password in the storage config.
3. Restart and confirm the connection pool opens without authentication errors.
4. Run one write action, then verify the table or database file was updated.

Purpose: Provides persistent storage for player data, stats, transactions, vaults or network state.

Troubleshooting: If storage fails, copy the first SQL error, then verify credentials, database permissions, driver availability and firewall access.

1. Create the database and user before enabling SQL storage.
2. Enter host, port, database, username and password in the storage config.
3. Restart and confirm the connection pool opens without authentication errors.
4. Run one write action, then verify the table or database file was updated.

Purpose: Connects this product to another Nexa plugin so team, chat, combat, shop or vault state can be reused.

Troubleshooting: If the Nexa bridge does not react, confirm both plugin versions are compatible and that the shared module/hook is enabled on the same server.

1. Install both Nexa plugins on the same server or network target.
2. Confirm both products load successfully before testing the bridge.
3. Enable the related hook or module in config when available.
4. Test the shared workflow, such as team checks, chat metadata, combat restrictions, shop transactions or vault access.

Purpose: Connects this product to another Nexa plugin so team, chat, combat, shop or vault state can be reused.

Troubleshooting: If transactions fail, verify the currency id, provider startup order and whether the player has enough balance or inventory space.

1. Install the economy/shop provider and create the currency key used by this product.
2. Match the currency id in the product config.
3. Test a buy/sell/withdraw flow with a player account.
4. Check transaction logs if balances do not change.

1. Enable sharing/community vault feature.
2. Create a dedicated shared vault type.
3. Add viewer/member/manager roles separately.
4. Test access, removal and ownership transfer while closed.

1. Export or back up vault contents.
2. Announce reset and lock writes during migration.
3. Verify audit/history and restore test data before reopening.

Confirm the player has vault permission, the team/player vault exists and the menu/storage layer did not fail during startup.

Check vault close/save errors, item serialization compatibility and whether the server shuts down before async saves finish.

Confirm admin spy/edit permission and whether the target vault is locked by another viewer or storage operation.

Check the upgrade tier order, economy provider, permission multipliers and configured price path.

Verify host, port, database name, credentials, firewall access and the storage type in the generated YAML file.

Verify snapshots are enabled, snapshot storage exists and the restore target vault is not open during restore.