Reference

Configuration

The main file is plugins/mcVaults/config.yml. Run /mv reload after editing. The most useful options:

Storage#

storage:
  type: YAML
  # Background save interval for online players. 0 = only on quit and shutdown.
  autosave-minutes: 10
  # Purchase-history rows kept per player (oldest are removed first).
  history-limit: 100

Key behavior#

keys:
  quick-open: true
  preview-on-use: true
  # When a player has both, use these first: VIRTUAL or PHYSICAL.
  use-first: VIRTUAL
  # On purchasable crates, use a key (if the player has one) before money.
  keys-before-buying: true
  notify: true
  broadcast-keyall: true

Limited-win announcement#

broadcast:
  # Announce wins of LIMITED rewards (messages.yml broadcast-limited).
  limited-wins: true
  # Clickable link in that announcement ({store}).
  store-url: "https://store.yourserver.net"
  # Sound played to everyone online ("none" = off).
  limited-sound: "ui.toast.challenge_complete"
  limited-particles: true
  center-limited: true
Set your store link

Change broadcast.store-url to your real store address, or the announcement will link to the placeholder.

Price formats#

economy:
  price-format:
    format: "{amount}"
    decimals: 2
    thousands-separator: true
    compact: false
    providers:
      vault:
        format: "${amount}"
        decimals: 2
      playerpoints:
        format: "{amount} Points"
        decimals: 0
        compact: true
    currencies: {}

The most specific format wins: a per-currency entry, then the provider, then the global values. A crate picks a currency entry with currency: <id>. Example entry: gems: {format: "{amount} Gems", decimals: 0, name: "Gems"}.

Bulk opening#

bulk:
  # Most crates opened in one action (also capped per crate by bulk-max).
  max-opens: 10
  # Wait between multi-opens, per player, in seconds. 0 = none.
  cooldown-seconds: 3
  results-gui: true
  # Ticks between each reward appearing in the results menu (0 = all at once).
  reveal-ticks: 3

Crate-level options#

These go at the top of each crate file:

OptionMeaning
display-nameCrate name (MiniMessage).
animationAnimation id (file name in animations/).
purchasable, price, economy, currencyBuy-to-open settings. Economy is vault, playerpoints or none.
permissionCustom permission node needed to open. Empty uses mcvaults.user.open.<crate-id>.
bulk-maxMost opens per action for this crate. The lower of this and bulk.max-opens applies.
tiers, pity, duplicate, rewards, key, menu, milestones, showcase, hologramSee the matching sections of this page.

Other#

debug: true prints extra loader detail to the console. Chat text is in messages.yml, which also has the help text shown by /mv help.