Configuration
XpBank comes with several configuration options which can be edited in the config.yml file under the XpBank folder located in the plugins directory of your server after you run it with XpBank installed.
In any place where there is text you can also use color codes such as &a to change the color of the text in-game
Default config.yml file
# XpBank version 1.12.2
# Spigot page: https://www.spigotmc.org/resources/xpbank.101132/
#
# ----- Placeholders -----
# The following placeholders will work in the GUI config and in messages, along with "_RAW" added to the end:
# - %MAX_LEVEL_HELD%
# - %MAX_LEVEL_STORED%
# - %MAX_XP_HELD%
# - %MAX_XP_STORED%
# - %XP_HELD
# - %XP_STORED%- %TOTAL_XP%
# - %TOTAL_XP_LEVEL%
# ----- Config Explanation -----
# maxXpStored: Maximum amount of xp points a user can store in the xp bank. (Whole number > 0 below 2B)
# maxXpHeld: Amount of xp points when the bank will stop adding to the player. (Whole number > 0 below 2B)
# seePlayerBalances: Toggles whether the /xpbal command is enabled
# topXpCommand: Toggles whether the /topxp command is enabled
# guiMenu: Toggles whether the plugin will use the gui menu when /xpbank is used.
# update-message: Toggles whether the plugin will send a message to admins saying an update is available for the plugin
# notify-on-admin-balance-change: Toggles whether users are sent a message when an admin modifies their balance with admin commands
# messages.noPermission: Message sent to players when they run a command they do not have permission to use
# messages.improperUse: Message sent to players when they use improper arguments in a command
# messages.exeeds-hold-limit: Message sent if a player tries to hold more than the max xp
# messages.exeeds-store-limit-target: Message sent to player if they're trying to give someone xp but it would push them over the max
# messages.exceeds-store-limit: Message sent to player if a player tries to store more than the max xp
# messages.deposit: Message sent to player when they deposit xp
# messages.withdraw: Message sent to player when they withdraw xp
# messages.player-not-found: Message sent to player when the plugin cannot find the player they specified
# messages.xp-stored: Message sent to player saying how much xp they have stored
# messages.xp-held: Message sent to player saying how much xp they are holding
# messages.no-xp-to-deposit: Message sent to player when they try to deposit but have no xp
# messages.no-xp-to-withdraw: Message sent to player when they try to withdraw but have no xp in the bank
# messages.total-xp: Message sent to player saying the total xp they have held and stored
# gui.main-menu.name: The name of the main GUI menu
# gui.deposit-menu.name: The name of the deposit GUI menu
# gui.withdraw-menu.name: The name of the wihtdrawl GUI menu
# gui.<menu>.<value>: All other entries of this format are the respective items held in that menu
# ----- More info -----
# For more information visit the XpBank wiki at https://github.com/ACM02/XpBank/wiki
maxXpStored: 2000000000
maxXpHeld: 2000000000
seePlayerBalances: true
topXpCommand: true
guiMenu: true
update-message: true
notify-on-admin-balance-change: true
messages:
noPermission: '&cYou don''t have permission to do that'
improperUse: '&cImproper usage. Try '
exeeds-hold-limit: '&cInvalid amount. That exceeds the maximum xp that can be held.
(%MAX_LEVEL_HELD% levels/%MAX_XP_HELD% points)'
exeeds-store-limit-target: '&cInvalid amount. That exceeds the maximum xp that can
be held by the target. (%MAX_LEVEL_HELD% levels/%MAX_XP_HELD% points)'
exceeds-store-limit: '&cInvalid amount. That exceeds the maximum xp that can be
stored. (%MAX_LEVEL_STORED% levels/%MAX_XP_STORED% points)'
deposit: '&aXp deposited. New balance: %XP_STORED%'
withdraw: '&aXp withdrawn. New balance: %XP_STORED%'
player-not-found: '&cPlayer not found.'
xp-stored: '&eYou have %XP_STORED% experience points in the bank. (Enough for level
%TOTAL_XP_LEVEL%)'
xp-held: '&eYou are holding %XP_HELD% xp'
no-xp-to-deposit: '&cYou don''t have any XP to deposit'
no-xp-to-withdraw: '&cYou don''t have any XP to withdraw'
total-xp: '&eYour total xp held and in the bank is: %TOTAL_XP%'
gui:
main-menu:
name: XpBank
deposit:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GOLD_INGOT
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit XP"}],"text":""}'
lore:
- '{"extra":[{"text":"&eStore up to %MAX_LEVEL_STORED% levels"}],"text":""}'
withdraw:
==: org.bukkit.inventory.ItemStack
v: 3218
type: IRON_INGOT
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw XP"}],"text":""}'
lore:
- '{"extra":[{"text":"&eHold up to %MAX_LEVEL_HELD% levels"}],"text":""}'
held-full:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_STAINED_GLASS_PANE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&eXp held:"}],"text":""}'
lore:
- '{"extra":[{"text":"&a%XP_HELD%/%MAX_XP_HELD%"}],"text":""}'
held-empty:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GRAY_STAINED_GLASS_PANE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&eXp held:"}],"text":""}'
lore:
- '{"extra":[{"text":"&a%XP_HELD%/%MAX_XP_HELD%"}],"text":""}'
stored-full:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_STAINED_GLASS_PANE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&eXp Stored:"}],"text":""}'
lore:
- '{"extra":[{"text":"&a%XP_STORED%/%MAX_XP_STORED%"}],"text":""}'
stored-empty:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GRAY_STAINED_GLASS_PANE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&eXp Stored:"}],"text":""}'
lore:
- '{"extra":[{"text":"&a%XP_STORED%/%MAX_XP_STORED%"}],"text":""}'
deposit-menu:
name: Deposit
25-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 25%"}],"text":""}'
50-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 50%"}],"text":""}'
75-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 75%"}],"text":""}'
100-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 100%"}],"text":""}'
max:
==: org.bukkit.inventory.ItemStack
v: 3218
type: EMERALD_BLOCK
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit max"}],"text":""}'
1-level:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 1 level"}],"text":""}'
5-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 5 levels"}],"text":""}'
10-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 10 levels"}],"text":""}'
15-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aDeposit 15 levels"}],"text":""}'
withdraw-menu:
name: Withdraw
25-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 25%"}],"text":""}'
50-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 50%"}],"text":""}'
75-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 75%"}],"text":""}'
100-percent:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_CONCRETE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 100%"}],"text":""}'
max:
==: org.bukkit.inventory.ItemStack
v: 3218
type: EMERALD_BLOCK
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw max"}],"text":""}'
1-level:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 1 level"}],"text":""}'
5-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 5 levels"}],"text":""}'
10-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 10 levels"}],"text":""}'
15-levels:
==: org.bukkit.inventory.ItemStack
v: 3218
type: GREEN_WOOL
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: '{"extra":[{"text":"&aWithdraw 15 levels"}],"text":""}'There are 5 values in config.yml that control some of the basic functionality of the plugin. They are:
maxXpStored - This is the maximum amount of experience any user can store in the XpBank.
maxXpHeld - This is the maximum amount of experience that can be held by a player. Note: This does NOT have ANY effect on experience gained through any means other than through the bank.
seePlayerBalances - true/false value which enables or disables the /xpbal command
topXpCommand - true/false value which enables or disables the /topxp command
guiMenu - true/false value which enables or disables the GUI menu, this controls the behavior of /xpbank
update-message - Toggles the message sent to admins about available plugin updates
notify-on-admin-balance-change - Toggles if the plugin notifies users when an admin modifies their balance with admin commands
XpBank has a set of special placeholders that can be used in messages and items in the config.yml file.
Note: _RAW can be added to the end of any of these placeholders to give just the number value. As of version 1.12.0 placeholders without _RAW will be formatted to have less digits and K,M, or B after for thousands, millions, and billions.
%MAX_LEVEL_HELD% - This will be replaced with the value in maxXpHeld converted to a number of experience levels.
%MAX_LEVEL_STORED - This will be replaced with the value in maxXpStored converted to a number of experience levels.
%MAX_XP_HELD% - This will be replaced with the value in maxXpHeld.
%MAX_XP_STORED - This will be replaced with the value in maxXpStored.
These placeholders will not work in all places as player information is sometimes not connected to a placeholder.
%XP_HELD - This will be replaced by the amount of experience a given player is holding.
%XP_STORED - This will be replaced by the amount of experience a given player has in the XpBank.
%TOTAL_XP% - This will be replaced by the experience held by a player plus their experience stored in the XpBank.
%TOTAL_XP_LEVEL - This will be replaced by the experience held by a player plus their experience stored in the XpBank converted to a number of experience levels.
Several of the messages in XpBank can be customized as well, all of these messages will support all placeholders listed above.
messages.noPermission - Message sent to players when they run a command they do not have permission to use
messages.improperUse - Message sent to players when they use improper arguments in a command
messages.exeeds-hold-limit - Message sent if a player tries to hold more than the maximum xp
messages.exeeds-store-limit-target - Message sent to player if they're trying to give someone xp but it would push them over the maximum amount that can be held
messages.exceeds-store-limit - Message sent to player if a player tries to store more than the maximum xp
messages.deposit - Message sent to player when they deposit experience
messages.withdraw - Message sent to player when they withdraw experience
messages.player-not-found - Message sent to player when the plugin cannot find the player they specified
messages.xp-stored - Message sent to player saying how much xp they have stored
messages.xp-held- Message sent to player saying how much xp they are holding
messages.no-xp-to-deposit - Message sent to player when they try to deposit but have no xp
messages.no-xp-to-withdraw - Message sent to player when they try to withdraw but have no xp in the bank
messages.total-xp - Message sent to player saying the total xp they have held and stored
XpBank offers customization for the GUI interface as well. All items in any can be edited, which includes: (Placeholders can be used in the display-name and lore of the items, player specific ones can be used in gui.main-menu.xp-stored and gui.main-menuxp-held)
Note: If you make 2 items identical to one another in the same menu the plugin will not be able to determine which is which and will break
gui.main-menu.name - The name used for the main menu.
gui.main-menu.deposit - The item used to enter the deposit menu
gui.main-menu.withdraw - The item use to enter the withdraw menu
gui.main-menu.held-full - The item used on the top of the main menu which shows how much experience the user is holding as a percent of the max.
Image
gui.main-menu.held-empty - The other item used on the top of the main menu which shows how much experience the user is holding as a percent of the max.
Image
gui.main-menu.stored-full - The item used on the top of the main menu which shows how much experience the user has stored as a percent of the max.
gui.main-menu.stored-empty - The other item used on the top of the main menu which shows how much experience the user has stored as a percent of the max.
gui.deposit-menu.name - The name used for the deposit menu
gui.deposit-menu.25-percent - The item used to deposit 25% of the player's experience.
gui.deposit-menu.50-percent - The item used to deposit 50% of the player's experience.
gui.deposit-menu.75-percent - The item used to deposit 75% of the player's experience.
gui.deposit-menu.100-percent - The item used to deposit 100% of the player's experience.
gui.deposit-menu.1-level - The item used to deposit 1 level of the player's experience.
gui.deposit-menu.5-levels - The item used to deposit 5 levels of the player's experience.
gui.deposit-menu.10-levels - The item used to deposit 10 levels of the player's experience.
gui.deposit-menu.15-levels - The item used to deposit 15 levels of the player's experience.
gui.deposit-menu.max - The item used to deposit the maximum experience the player can deposit.
gui.deposit-menu.name - The name used for the deposit menu
gui.withdraw-menu.25-percent - The item used to deposit 25% of the player's XpBank balance.
gui.withdraw-menu.50-percent - The item used to deposit 50% of the player's XpBank balance.
gui.withdraw-menu.75-percent - The item used to deposit 75% of the player's XpBank balance.
gui.withdraw-menu.100-percent - The item used to deposit 100% of the player's XpBank balance.
gui.withdraw-menu.1-level - The item used to withdraw 1 level from the XpBank.
gui.withdraw-menu.5-levels - The item used to withdraw 5 levels from the XpBank.
gui.withdraw-menu.10-levels - The item used to withdraw 10 levels of from the XpBank.
gui.withdraw-menu.15-levels - The item used to withdraw 15 levels of from the XpBank.
gui.withdraw-menu.max - The item used to withdraw the maximum experience the player can withdraw.