PlayerVaults999

Features

• A clickable vault menu that shows every vault a player can use.
• Persistent vaults: contents are saved when a vault is closed, on a timer, when a player leaves, and on shutdown.
• Per-vault custom names and icons shown in the menu.
• A separate sorting screen with sorting by name, by type and by quantity.
• Item search across a player's vaults with clickable results.
• Buying locked vaults with an economy, without requiring Vault to be installed.
• Administrator tools for backups, wiping, read-only viewing and reloading.
• Every message, menu title and icon can be changed in the configuration.
• Vault access can be handed out per vault number, or all at once.

How vaults work

• A player's vaults are numbered from 1 up to max_vaults.
• Access is granted per vault number with a permission, or all at once with the "all vaults" permission, or by buying the vault.
• Running /pv opens the vault menu. The menu shows one icon per vault, how many items it holds, its custom name and its custom icon.
• In the menu, left-click a vault to open it and right-click it to open its sorting screen.
• Locked vaults are shown greyed out. When an economy is available they can be clicked to buy them, and they stay unlocked after purchase.
• Vault contents slide into place automatically when a vault is opened, sorted or cleared, and everything is stored safely between restarts.

Commands

Command	What it does
/pv	Opens the vault menu.
/pv menu	Opens the vault menu.
/pv <number>	Opens one of your vaults by number.
/pv list	Lists the vaults you can access.
/pv search <item>	Searches all your vaults for an item. The results are clickable and open the matching vault.
/pv sort <vault>	Opens the sorting screen for a vault.
/pv clear <vault>	Empties one of your vaults.
/pv buy <vault>	Buys a locked vault when an economy is available.
/pv name <vault> <name>	Renames a vault. Use clear as the name to remove a custom name.
/pv icon <vault> <item>	Sets the menu icon for a vault.
/pv admin <player> <vault>	Opens another player's vault so it can be edited.
/pv inspect <player> <vault>	Opens another player's vault as a read-only view.
/pv backup <player>	Creates a dated backup copy of a player's vault data.
/pv wipe <player> [vault]	Clears one or all of a player's vaults. A backup is always taken first.
/pv reload	Reloads the configuration without restarting the server.

Tab completion is available for every command, sub-command, vault number, player name and item name.

Permissions

Permission	Default	What it allows
playervaults.use	Everyone	Using the /pv command and the vault menu.
playervaults.vaults.<number>	Vault 1 only	Access to one vault number.
playervaults.vaults.all	Operators	Access to every vault.
playervaults.admin	Operators	Opening and editing any player's vault, and the administrator commands.
playervaults.clear	Operators	Clearing a vault.
playervaults.list	Everyone	Listing available vaults.
playervaults.search	Everyone	Searching vaults for items.
playervaults.sort	Everyone	Sorting a vault.
playervaults.rename	Everyone	Renaming a vault.
playervaults.icon	Everyone	Changing a vault's menu icon.
playervaults.economy	Everyone	Buying locked vaults.
playervaults.inspect	Operators	Viewing another player's vault read-only.
playervaults.backup	Operators	Creating vault backups.
playervaults.wipe	Operators	Wiping vault data.
playervaults.reload	Operators	Reloading the configuration.

Vault permissions are provided for numbers 1 to 10 by default. If max_vaults is higher than 10, give those players the "all vaults" permission, or add matching vault permissions.

Economy

Vaults can be sold once the Vault plugin and an economy plugin are installed.

• When an economy is available, locked vaults in the menu show their price and can be bought with a click, or with /pv buy <vault>.
• The price of vault number n is base_price + price_increase * (n - 1).
• Bought vaults stay unlocked for that player and are remembered between restarts.
• If Vault or an economy plugin is missing, the plugin runs normally. Players who try to buy a vault are simply told that Vault is required, and locked vaults show as locked instead of purchasable.

Configuration

Every option lives in the plugin's config.yml. Colour codes use &, for example &a is green. Available placeholders are %prefix%, %player%, %vault%, %name%, %count%, %amount%, %item%, %price%, %page%, %pages%, %file%, %icon% and %max%.

General

Option	Default	What changing it does
max_vaults	10	The highest vault number a player can have. Vaults are numbered from 1 up to this value.
vault_size	54	The number of storage slots in a vault. Must be a multiple of 9, between 9 and 54. Applies to vaults created after the change; existing vaults keep their size so no items are lost.
save_interval	300	How often, in seconds, changed vaults are saved automatically. Set to 0 to turn automatic saving off; vaults are still saved when closed and on shutdown.
preload_offline_vaults	false	When true, vault information for offline players is loaded at startup.
vault_title	&a%player%'s Vault #%vault%	The title shown at the top of a vault.
sound_on_open	UI_BUTTON_CLICK	The sound played when a vault is opened. Accepts a sound name or a namespaced sound such as minecraft:ui.button.click. Leave blank for no sound.

Menu

Option	Default	What changing it does
menu.title	&8Your Vaults	The title of the vault menu.
menu.vault_icon	CHEST	The icon used for a vault the player can open. Vaults with a custom icon use that instead.
menu.locked_icon	BARRIER	The icon used for a vault the player cannot open and cannot buy.
menu.buy_icon	GOLD_INGOT	The icon used for a vault the player can buy.
menu.fill_empty_slots	true	When true, unused menu slots are filled with the filler item.
menu.filler	GRAY_STAINED_GLASS_PANE	The item used to fill unused menu slots.

Sorting and screens

Option	Default	What changing it does
sort.title	&8Sort Vault #%vault%	The title of the sorting screen.
sort.sound	UI_BUTTON_CLICK	The sound played when a vault is sorted. Leave blank for no sound.
buy.title	&8Purchase Vault #%vault%	The title of the purchase confirmation screen.
inspect.title	&8Viewing %player% #%vault%	The title of the read-only screen used by /pv inspect.

Economy

Option	Default	What changing it does
economy.enabled	true	Set to false to disable buying vaults even when an economy is available.
economy.base_price	1000.0	The cost of vault number 1. Higher vaults cost more.
economy.price_increase	1000.0	Added to the price for each vault number above 1. With the defaults, vault 2 costs 2000.

Messages

Every message players see can be changed in the messages section.

Option	Default	When it is shown
prefix	&8[&aVaults&8] &r	Added in front of every message below.
player-only	&cThis command can only be used by players.	When a command that needs a player is run from the console.
no-permission	&cYou don't have permission to do that.	When a command is run without the needed permission.
player-not-found	&cPlayer not found.	When an administrator command names an unknown player.
invalid-number	&cPlease enter a valid vault number.	When a non-number is given as a vault number.
vault-range	&cVault number must be between 1 and %max%.	When a vault number is outside the allowed range.
vault-locked	&cYou don't have access to that vault.	When a player tries to open a vault they cannot access.
cleared	&aVault #%vault% has been cleared.	After clearing a vault.
sorted	&aVault #%vault% has been sorted.	After sorting a vault.
usage	&cUsage: /pv [...]	When a command is missing arguments.
list-header	&aYour available vaults:	Above the /pv list results.
list-entry	&7- Vault #%vault% %name%	One line per vault in /pv list.
search-header	&aFound items:	Above the /pv search results.
search-entry	&aVault #%vault% &7- %item% x%amount%	One clickable line per matching item.
search-hover	&7Click to open vault #%vault%	Shown when hovering a search result.
search-none	&cNo items found matching that name.	When a search finds nothing.
search-hint	&7Click a result to open that vault.	Below the /pv search results.
menu-page	&ePage %page%/%pages%	The page indicator in the menu.
menu-prev	&aPrevious Page	The previous-page button in the menu.
menu-next	&aNext Page	The next-page button in the menu.
vault-item-name	&aVault #%vault%	The name of a vault icon in the menu when it has no custom name.
vault-item-lore	item count and click hints	The hover text of a vault icon in the menu.
locked-item-name	&cVault #%vault% &7(Locked)	The name of a locked vault icon.
locked-item-lore	price and purchase hint	The hover text of a vault that can be bought.
locked-no-economy-lore	access hint	The hover text of a vault that cannot be bought.
sort-name	&aSort by Name	The sort-by-name button.
sort-type	&aSort by Type	The sort-by-type button.
sort-quantity	&aSort by Quantity	The sort-by-quantity button.
sort-close	&cClose	The close button on the sorting screen.
buy-confirm	&aConfirm Purchase	The confirm button on the purchase screen.
buy-confirm-lore	price line	The hover text of the confirm button.
buy-cancel	&cCancel	The cancel button on the purchase screen.
buy-success	&aYou unlocked vault #%vault%!	After buying a vault.
buy-failed	&cYou cannot afford that.	When a purchase fails.
buy-already	&eYou already have access to vault #%vault%.	When buying a vault you already have.
buy-no-economy	&cThis feature requires the Vault plugin...	When an economy command is used without Vault.
name-set	&aVault #%vault% renamed to &f%name%&a.	After renaming a vault.
icon-set	&aVault #%vault% icon set to &f%icon%&a.	After changing a vault icon.
icon-invalid	&cInvalid item name: %icon%	When an unknown item name is given as an icon.
reloaded	&aConfiguration reloaded.	After /pv reload.
backup-done	&aBackup created: &f%file%	After creating a backup.
backup-none	&cNo vault data was found for that player.	When there is nothing to back up.
wipe-done	&aVault data wiped for &f%player%&a.	After wiping vaults.

Installation

1. Place the plugin file in the server's plugins folder.
2. Start the server once to create the configuration.
3. Optionally install Vault and an economy plugin to enable buying vaults.
4. Adjust config.yml to taste and run /pv reload to apply the changes.