diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index d8aa646..854f780 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -1,16 +1,17 @@ # Database configuration db: - # Select here the database you want to use + # Select here the database you want to use. # The following databases are supported: - # - sqlite - (default) stores all data in a local file - # - mariadb - allows using a remote database with JDBC - # IMPORTANT! If you change the DB type, the data is not automatically migrated between databases. + # sqlite → (default) stores all data in a local file + # mariadb → allows using a remote database with JDBC + # IMPORTANT! + # If you change the database type, the data is NOT automatically migrated between databases! db: sqlite # SQLite sqlite: - # Database file name (in the plugin's folder) - # If the file does not exist, it will be created + # Database file name (in the plugin’s folder). + # If the file does not exist, it will be created. file: bank.db # MariaDB @@ -23,7 +24,7 @@ db: password: ChangeThis! # Advanced configuration (do not touch unless you know what you are doing) - # HikariCP. Comment out any data source property to disable setting it. + # HikariCP options. cachePrepStmts: true prepStmtCacheSize: 250 prepStmtCacheSqlLimit: 2048 @@ -36,14 +37,17 @@ db: maintainTimeStats: false integrations: + # BankAccounts can work as a Vault economy provider. + # If enabled, BankAccounts will be the Vault back-end for handling funds. + # May not work correctly if you have other plugins that *provide* a Vault economy system. vault: - # Enable Vault integration + # Whether to enable the Vault integration. enabled: false - # Transaction description for all vault operations + # The description shown for all Vault transactions. description: Vault Transaction - # Name of the server Vault account + # Name of the server Vault account. # All Vault transactions will appear as to/from this account. server-account: Server Vault @@ -55,64 +59,74 @@ currency: # See https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/DecimalFormat.html#special_pattern_character format: "#,##0.00" -# Starting balance -# Min value is 0. Set to "false" to disable creating an account on join. -# If the Vault integration is enabled and this is set to "false", an account with 0 balance will be created regardless. +# Starting balance. +# The minimum value is ‘0’. +# Set to ‘false’ to disable creating an account on join. +# If the Vault integration is enabled and this is set to ‘false’, +# an account with balance ‘0’ will be created regardless! starting-balance: 0 # Server account server-account: - # If enabled, when the plugin is loaded an account will be created as player with UUID 00000000-0000-0000-0000-000000000000 - # This is required for features like interest to work. + # If enabled, when the plugin is loaded, an account will be created as + # a player with UUID ‘00000000-0000-0000-0000-000000000000’. + # Enabling this is required for features like interest to work. enabled: true - # Display name for the server account + + # Display name for the server account. name: Central Bank + # Account type # Possible values: - # 0: Personal account - # 1: Business account + # 0 → Personal account. + # 1 → Business account. type: 1 + # Starting balance - # Use `Infinity` for infinite ∞ balance + # Use ‘Infinity’ for infinite ∞ balance starting-balance: Infinity # Maximum number of accounts a player can have # Account types: -# 0: Personal account -# 1: Business account +# 0 → Personal account +# 1 → Business account # Limits: -# 0: cannot have any accounts -# -1: unlimited accounts +# 0 → cannot have any accounts +# -1 → unlimited accounts # -# Players can open accounts themselves if they have `bank.account.create`. These limits also apply if someone else -# creates bank accounts for other players with the admin permission `bank.account.create.other`. You can bypass the -# limits using `bank.account.create.bypass`. +# Players can open accounts themselves if they have the ‘bank.account.create’ permission. +# These limits also apply if someone else creates bank accounts for other players with the +# admin permission ‘bank.account.create.other’. +# You can bypass the limits using the ‘bank.account.create.bypass’ permission. account-limits: # Personal accounts 0: 1 # Business accounts 1: -1 -# Top balance leaderboard -# Accounts with infinite balance are excluded +# Top balance leaderboard. +# Accounts with infinite balance are excluded. baltop: - # How many accounts to show per page + # The number of accounts to show per page. per-page: 10 -# Transfer confirmation +# Transfer confirmation. +# This is to prevent accidentally transferring large amounts. transfer-confirmation: - # If enabled, players will be shown a transfer overview asking them to confirm the transfer + # If enabled, players will be shown a transfer overview asking them to confirm the transfer. enabled: true - # Minimum transfer amount to show confirmation for - # Min transfer amount is > 0, so setting this to 0 will enable confirmation for all transfers amounts + + # The minimum transfer amount that requires confirmation. + # Setting this to ‘0’ will enable confirmation for all transfers. min-amount: 200 - # If true, confirmation will not be required for transfers between own accounts + + # If true, confirmation will NEVER be shown for transfers between own accounts. bypass-own-accounts: true -# Transactions history +# Transactions history. history: - # Number of transactions to return per page - # You can use `/bank transactions --all` to view all transactions + # Number of transactions to return per page. + # You can use ‘/bank transactions --all’ to view all transactions. per-page: 10 # Payment instruments @@ -121,199 +135,225 @@ instruments: # The in-game item to use. See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html material: PAPER - # Require the player to have an item in their inventory of the same material in order to create a new instrument. + # Require the player to have an item in their inventory of the same material to create a new instrument. # The item is consumed and replaced with the instrument. This is recommended to prevent limitless generation of # items. Payment instruments CAN be used in crafting recipes and villager trading as if they were regular items. - # You can bypass this requirement using `bank.instrument.create.bypass`. Non-players (e.g. console, command blocks, - # etc.) always bypass this requirement. + # You can bypass this requirement using the ‘bank.instrument.create.bypass’ permission. + # Non-players (e.g. console, command blocks, etc.) always bypass this requirement. require-item: true - # The name of the item + # The name of the item. # Placeholders: - # - - Account name. Defaults to owner username or ID if not set. - # - - Account ID - # - - Account type (Personal or Business) - # - - Account owner username - # - - Date card was created. You can use . Check here for patterns: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns + # → Account name. + # Defaults to owner username or ID if not set. + # → Account ID. + # → Account type (Personal or Business). + # → Account owner username. + # → Date the card was created. + # You can use ‘’. + # Check here for patterns: + # https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns # NOTE: The placeholders are set only when the item is created. - # If the account is renamed or the balance changes, the text on the item will NOT be updated. - # Additionally, if you modify this, it will only be effective for new bank cards. - name: "Bank Card — " + # If the account is renamed, the balance changes, etc., the text on the item will NOT be updated. + # Additionally, if you modify this, it will only be effective for newly created bank cards. + # (Old ones will still work) + name: Bank Card — - # Lore of the item (text below the name) - # Same placeholders as name + # Lore of the item (text below the name). + # Same placeholders as ‘name’. lore: - - ", " - - "#" - - "Issued " - - "Owner: " + - , + - # + - Issued + - Owner: - # Item glint - # This makes the item shine as if enchanted + # Item glint. + # This makes the item shine as if enchanted. glint: enabled: true - # The hidden enchantment to apply to the item - # Enchantments are the same as seen in the `/enchant` command. Do not include the `minecraft:` prefix. - # If you set this to something like "vanishing_curse" the item will disappear when the player dies. + # The hidden enchantment that is applied to the item. + # Enchantment names are the same as seen in the ‘/enchant’ command. + # Do NOT include the ‘minecraft:’ prefix. + # If you set this to something like ‘vanishing_curse’, the item will disappear when the player dies. # If you use a compatible enchantment with the item material, the enchantment will be fully functional. - # (e.g. if your item is a sword, and you use "sharpness", the sword will deal more damage, even though the - # enchantment is not listed in the lore. it is recommended to avoid that) - # Level 1 is always applied. + # (e.g. if your item is a sword, and you use ‘sharpness’, the sword will deal more damage, even though the + # enchantment is not listed in the lore. It is recommended to avoid that.) + # BankAccounts will always use level 1 of the enchantment. enchantment: unbreaking -# POS -# Note: you cannot use etc. in GUIs +# Point of Sale. +# This is a chest that can have any items. +# Players can buy all the items in the POS for the specified price. +# Note: you cannot use etc. in GUIs! pos: - # Allow creating POS with a PERSONAL account - # If you want to require players to use a business account, set this to false. - # You can bypass this with `bank.pos.create.personal` + # Allow creating POS with a PERSONAL account. + # If you want to require players to use a business or Vault account, set this to ‘false’. + # You can bypass this with the ‘bank.pos.create.personal’ permission. allow-personal: false - # The title shown at the top of the GUI when opening a POS + # The title shown at the top of the preview GUI when opening a POS. # Placeholders: - # - POS description - # - Price of the POS contents without formatting, example: 123456.78 - # - Price of the POS contents with formatting, example: $123,456.78 - # - Price of the POS contents with formatting, example: $123k - title: "Point of Sale — " + # → POS description + # → Price of the POS contents without formatting, example: 123456.78 + # → Price of the POS contents with formatting, example: $123,456.78 + # → Price of the POS contents with formatting, example: ‘$123k’. + title: Point of Sale — - # POS info item + # The item inside the POS preview GUI that shows information about the POS. info: # Available materials: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html material: PAPER - # Glint / glow (does not work on all items) + # Glint/glow (does not work on some items). glint: true - # Item name when owner is viewing the POS. - # Same placeholders as POS title. - name-owner: "POS" - # Item name when potential buyer is viewing the POS. + # The name of the item when the POS owner is previewing the POS. # Same placeholders as POS title. - # Extra placeholders: same as `messages.balance`. The account is of the owner of the POS. - name-buyer: "POS — " + name-owner: POS + + # The name of the item when a potential POS buyer is previewing the POS. + # All placeholders from POS title can be used. + # All placeholders from ‘messages.balance’ can be used (the account is the POS owner’s). + name-buyer: POS — - # Lore lines when owner is viewing the POS. + # Item lore lines when the POS owner is previewing the POS. # Same placeholders as POS title. lore-owner: - - "Price: " - - "Description: " - # Same placeholders as name-buyer + - Price: + - Description: + + # Item lore lines when a potential POS buyer is previewing the POS. + # Same placeholders as ‘name-buyer’. lore-buyer: - - "Price: " - - "Description: " + - Price: + - Description: - # POS delete item (owner only) - # No placeholders. + # POS delete/cancel button (owner only). + # No placeholders! delete: material: BARRIER glint: false - name: "Cancel POS" + name: Cancel POS lore: - - "Click to cancel this POS." + - Click to cancel this POS. - # Confirm purchase item (buyer only) - # Same placeholders as name-buyer, but this time the account is of the buyer. + # POS purchase confirmation button (buyer only). + # Same placeholders as ‘name-buyer’, but this time the account is of the buyer. confirm: material: LIME_STAINED_GLASS_PANE glint: false - name: "Confirm Purchase" + name: Confirm Purchase lore: - - "Click to confirm purchase." - - "Price: " - - "Balance: " - - "Paying from: ()" - - "Account ID " - # Deny purchase item (buyer only) - # No placeholders. + - Click to confirm purchase. + - Price: + - Balance: + - Paying from: () + - Account ID + + # Decline purchasing the POS contents (buyer only). + # Clicking this simply closes the POS preview GUI. decline: material: RED_STAINED_GLASS_PANE glint: false - name: "Decline Purchase" + name: Decline Purchase lore: - - "Click to decline this purchase." + - Click to decline this purchase. -# Interest rate +# Interest rates. # Interest is paid from/to the server account. # If the server account has insufficient funds, interest payments will silently fail. -# NOTE: A transaction is created for each interest payment. +# NOTE: A transaction is created for each interest payment! interest: - # Personal accounts + # Interest on personal accounts. 0: - # Percent to add to the balance. If negative, it will be subtracted. Set to 0 to disable interest. - # Acceptable range: -100–100 + # The per cent to add to the balance. + # If negative, it will be subtracted. + # Acceptable range: rate ∈ [-100, 100] + # Set to ‘0’ to DISABLE interest. rate: 0 - # Interval time in real-life MINUTES for how often interest is added. + + # Interval time in real-life MINUTES for how often interest is paid. # Default: 24 hours (i.e. midnight every day). interval: 1440 - # Description shown in the transaction history + + # Description shown in the transaction history. # Available placeholders: - # - - Interest rate as decimal (e.g. "5") - # - - Formatted interest rate (e.g. "5%") - # - - Account balance before interest (e.g. "123456.78") - # - - Formatted balance before interest (e.g. "$123,456.78") - # - - Formatted balance before interest (e.g. "$123k") - description: "Interest payment ()" - # Business accounts + # → Interest rate as decimal (e.g. ‘5’). + # → Formatted interest rate (e.g. ‘5%’). + # → Account balance before interest (e.g. ‘123456.78’). + # → Formatted balance before interest (e.g. ‘$123,456.78’). + # → Formatted balance before interest (e.g. ‘$123k’). + description: Interest payment () + + # Interest on business accounts. + # The settings are the same as for personal accounts. 1: rate: 0 interval: 1440 - description: "Interest payment ()" + description: Interest payment () -# Invoice +# Invoices are money requests. invoice: - # Number of invoices to return per page + # The number of invoices to show per page when viewing lists of invoices. per-page: 10 - # Notifications for unpaid invoices (see messages.invoice.notify) + # Notifications for unpaid invoices (see configuration section ‘messages.invoice.notify’). + # NEVER sent if the player has 0 unpaid invoices. notify: - # Send message when a player joins + # If enabled, the message will be sent when a player joins. join: true - # Periodically send message while player is online - # Interval between messages in seconds - # Set to 0 or negative to disable + + # Periodically send a message while the player is online. + # This setting controls the interval between the messages in seconds. + # Set to ‘0’ or negative to disable this. interval: 300 -# Advanced: do not edit unless you have good understanding of RegEx -# Regular expression for disallowed characters user-provided text inputs -# e.g. account name, transaction description, POS description, invoice description -# Note: additionally <> and characters with code point above 0xFFFF are always disallowed. -disallowed-regex: [\x00-\x08\x0B-\x1F\x7F-\x9F\u2400-\u2421\u200B-\u200D\uFEFF\uD800-\uDB7F\uDFFF] +# Advanced: do not edit unless you have good understanding of regular expressions! +# Regular expression for disallowed characters in user-provided text inputs such as account name, +# transaction description, POS description, invoice description, etc. +# Note: additionally ‘<’, ‘>’, and characters with code point above 0xFFFF are ALWAYS disallowed. +disallowed-regex: "[\x00-\x08\x0B-\x1F\x7F-\x9F\u2400-\u2421\u200B-\u200D\uFEFF\uD800-\uDB7F\uDFFF]" +# This is the end of the functionality configuration! + +# # Messages +# In this part of the configuration, you can modify *all* messages used by the plugin. +# messages: - # Command usage message + # Command usage message. # Placeholders: - # - - The command name (e.g. "bank") - # - - The command usage arguments (e.g. "send [description]") - command-usage: "(!) Usage: / " + # → The command name (e.g. ‘bank’). + # → The command usage arguments (e.g. ‘send [description]’) + command-usage: (!) Usage: / - # Account types + # Display names for each account type. types: - # Personal account + # Personal account. 0: Personal - # Business account + # Business account. 1: Business - # Vault integration account used to integrate payments with other plugins + # Vault integration account (used to integrate payments with other plugins). 2: Checking help: - # Messages in /bank help + # Messages in ‘/bank help’. bank: - # Shown before any commands - # Set to nothing, e.g. "header:" (without quotes) to disable + # Shown before any commands. + # Set to nothing, e.g. ‘header:’ (without the quotes) to disable. header: | --- Available commands: + # Each command is only shown if the player has permission to use it. - # Set to nothing, e.g. "balance:" (without quotes) to disable a command + # Set to nothing, e.g. ‘balance:’ (without the quotes) to disable showing a command. # Placeholders: - # - - The base command name (e.g. "bank send"). - # - - The command usage arguments (e.g. " [description]"). + # → The base command name (e.g. ‘bank send’). + # → The command usage arguments (e.g. ‘ [description]’). commands: balance: >/ - List your accounts and check balances. - balance-other: --player >/ - List another player's accounts. + balance-other: --player >/ - List another player’s accounts. transfer: >/ - Transfer money to another account. history: >/ - List transactions. create: >/ - Open a new bank account. @@ -325,25 +365,28 @@ messages: whois: >/ - Get information about an account. baltop: >/ - Top balances leaderboard. pos: >/ - Create new Point Of Sale. - setbalance: >/ - Set an account's balance. - rename: >/ - Set an account's name. + setbalance: >/ - Set an account’s balance. + rename: >/ - Set an account’s name. reload: >/ - Reload the plugin configuration. invoices: >/ - See invoicing commands. - # Shown after all commands - # Set to nothing, e.g. "footer:" (without quotes) to disable + + # Shown after all commands. + # Set to nothing, e.g. ‘footer:’ (without the quotes) to disable. footer: --- - # Messages in /invoice help + + # Messages in ‘/invoice help’. invoice: - # Shown before any commands - # Set to nothing, e.g. "header:" (without quotes) to disable + # Shown before any commands. + # Set to nothing, e.g. ‘header:’ (without the quotes) to disable. header: | --- Available commands: + # Each command is only shown if the player has permission to use it. - # Set to nothing, e.g. "create:" (without quotes) to disable a command + # Set to nothing, e.g. ‘balance:’ (without the quotes) to disable showing a command. # Placeholders: - # - - The base command name (e.g. "invoice create"). - # - - The command usage arguments (e.g. " [description]"). + # → The base command name (e.g. ‘invoice create’). + # → The command usage arguments (e.g. ‘ [description]’). commands: create: >/ - Create an invoice that anyone can pay. create-player: >/ - Create and send an invoice for a specific player. @@ -352,141 +395,65 @@ messages: send: >/ - Send an invoice to a player. list: >/ - List your invoices. list-other: >/ - List another invoices of player. - # Shown after all commands - # Set to nothing, e.g. "footer:" (without quotes) to disable + + # Shown after all commands. + # Set to nothing, e.g. ‘footer:’ (without the quotes) to disable. footer: --- - # Errors - errors: - # You have no accounts - no-accounts: "(!) You have no bank accounts." - # No permission - no-permission: "(!) You do not have permission to use this command." - # Account not found - account-not-found: "(!) Account not found." - # Command not recognised - unknown-command: "(!) Unknown command. Try help>/." - # the account type - # the account limit for that type - max-accounts: "(!) You cannot open more than accounts." - rename-vault-account: "(!) You cannot rename this account." - # You do not own this account - not-account-owner: "(!) You are not the owner of this account." - # Account frozen (placeholders same as balance) - frozen: "(!) account () is frozen. This account cannot initiate or receive transactions." - # Cannot transfer to same account - same-from-to: "(!) The from and to accounts must be different." - # You can only make transfer between your own accounts - transfer-self-only: "(!) You can only make transfers between your own accounts." - # You can only transfer to account that are not yours - transfer-other-only: "(!) You cannot make a transfer between your own accounts." - # Invalid number. Placeholder is the invalid number - invalid-number: "(!) Invalid number: " - # $0 or negative transfer - negative-transfer: "(!) The amount to transfer must be greater than zero." - # Insufficient funds (placeholders same as balance) - insufficient-funds: "(!) Your account has insufficient funds. You have " - # Trying to close an account that has non-zero balance - closing-balance: "(!) You cannot close an account that has a non-zero balance. This account has " - # Command only for players - player-only: "(!) You must be a player to use this command." - # Player not found - player-not-found: "(!) Player not found." - # You must have a specific item to convert to an instrument - # Placeholders: - # - the item type that is required (the item ID) - # - item translation key, can be used together with > - instrument-requires-item: "(!) You must have x1 > in your inventory to create a bank card from." - # Target player's inventory is full - # Placeholder: - the target player's name - target-inventory-full: "(!) The inventory of is full." - block-too-far: "(!) The targeted block is too far away." - pos-already-exists: "(!) A POS already exists at this location." - pos-not-chest: "(!) The targeted block is not a chest." - pos-double-chest: "(!) The POS cannot be a double chest." - pos-empty: "(!) The chest is empty. POS cancelled." - pos-invalid-card: "(!) You need a valid bank card to use POS." - pos-no-permission: "(!) You do not have permission to use POS." - no-card: "(!) You must hold your bank card to use this." - pos-items-changed: "(!) The items in the chest have changed. POS cancelled." - pos-create-business-only: "(!) You can only create a POS with a business account." - # Provided string includes disallowed characters - # Placeholder: - the disallowed characters - disallowed-characters: "(!) The provided string contains disallowed characters: " - # Account is already frozen (placeholders same as balance) - already-frozen: "(!) This account is already frozen." - # Account is not frozen (placeholders same as balance) - not-frozen: "(!) This account is not frozen." - # Invoice negative amount - negative-invoice: "(!) The amount to invoice must be greater than zero." - # Invoice not found - invoice-not-found: "(!) Invoice not found." - # Invoice seller account is the same as payer - invoice-pay-self: "(!) You cannot pay your own invoice with the same account. You can use a different account." - invoice-already-paid: "(!) This invoice has already been paid." - # Cannot send this invoice to this player because either: - # a) the invoice has a set buy and that's not this player; OR - # b) the player does not have permission to view invoices not meant for them - invoice-cannot-send: "(!) You cannot send this invoice to that player because they don't have permission to view it." - # Player has never played on this server - player-never-joined: "(!) This player has never joined this server." - # Asynchronous code failed. Detailed info is outputted in the console - async-failed: "(!) The request failed. See the console for details." - # Trying to delete vault integration account - delete-vault-account: "(!) You cannot delete this account." - # Trying to transfer funds to the server Vault account - transfer-to-server-vault: "(!) You cannot transfer funds to this account. This account is for internal use only." - - # Account balance + + # Account balance. # Available placeholders: - # - Account name. Defaults to owner username or ID if not set. - # - Account ID - # - Account type (Personal or Business) - # - Account owner username - # - Account balance without formatting, example: 123456.78 - # - Account balance with formatting, example: $123,456.78 - # - Account balance with formatting, example: $123k + # → Account name. + # Defaults to owner username or ID if not set. + # → Account ID. + # → Account type (Personal or Business). + # → Account owner username. + # → Account balance without formatting, example: ‘123456.78’. + # → Account balance with formatting, example: ‘$123,456.78’. + # → Account balance with formatting, example: ‘$123k’. balance: |- ( account) Balance: Owned by > - # List accounts + # List accounts. list-accounts: - header: "Bank accounts" - # Same placeholders as balance - entry: "* >: Click to view'>: " + header: Bank accounts + + # Same placeholders as ‘balance’. + entry: * >: Click to view'>: - # Plugin reload - reload: "(!) Plugin configuration reloaded" + reload: (!) Plugin configuration reloaded - # Account created (same placeholders as balance) + # Account created. Same placeholders as ‘balance’. account-created: "(!) Successfully created account: >Click to view" - # Balance set (same placeholders as balance) - balance-set: "(!) Successfully set (, ) balance to " + # Balance set. Same placeholders as ‘balance’. + balance-set: (!) Successfully set (, ) balance to - # Account name set (same placeholders as balance) - name-set: "(!) Successfully renamed account " + # Account name set. Same placeholders as ‘balance’. + name-set: (!) Successfully renamed account - # Account has been successfully frozen (same placeholders as balance) - account-frozen: "(!) Successfully frozen account " + # The account has been successfully frozen. Same placeholders as ‘balance’. + account-frozen: (!) Successfully frozen account - # Account has been successfully unfrozen (same placeholders as balance) - account-unfrozen: "(!) Successfully unfrozen account " + # The account has been successfully unfrozen. Same placeholders as ‘balance’. + account-unfrozen: (!) Successfully unfrozen account - # Account deleted (same placeholders as balance) - account-deleted: "(!) Successfully deleted account " + # Account deleted. Same placeholders as ‘balance’. + account-deleted: (!) Successfully deleted account - # Transfer confirmation - # Placeholders are the same as balance. Add prefix `from-` for account sending and `to-` for account receiving - # Example: , + # Transfer confirmation. + # All placeholders from ‘balance’ are available. + # Add prefix `from-` for the account sending and `to-` for the account receiving. + # Example: ‘’, ‘’, …. + # # Additional placeholders: - # - Transfer amount without formatting, example: 123456.78 - # - Transfer amount with formatting, example: 123,456.78 - # - Transfer amount with formatting, example: 123k - # - Transfer description - # - Command to run to confirm transfer + # → Transfer amount without formatting, example: ‘123456.78’. + # → Transfer amount with formatting, example: ‘$123,456.78’. + # → Transfer amount with formatting, example: ‘$123k’. + # → Transfer description. + # → Command to run to confirm transfer. confirm-transfer: |- CONFIRM TRANSFER From: ( account of , ) @@ -496,122 +463,142 @@ messages: >Click to confirm transfer'>[I CONFIRM] - # Transfer sent (same placeholders as confirm-transfer, except confirm-command) + # Transfer sent. + # All placeholders from ‘confirm-transfer’ are available, except ‘confirm-command’. # Additional placeholders: - # - Transaction ID + # → Transaction ID. transfer-sent: (!) Successfully sent from : Owned by '> to Owned by '> ># - # Transfer received (same placeholders as transfer-sent) + # Transfer received. Same placeholders as ‘transfer-sent’. transfer-received: (!) You have received from Owned by '> in your : Owned by '> account: >(#) - # Transaction history + # Transaction history. history: - # All placeholders of `balance` are available + # All placeholders from ‘balance’ are available. # Additional placeholders: - # - Current page number - # - Maximum number of pages - # - Command to go to previous page - # - Command to go to next page - header: "Transaction history (: Owned by '>)" - # All placeholders of `balance` and `transfer-sent` are available. Use (no prefix) for your account and "other-" prefix for other account + # → Current page number. + # → Last page number. + # → Command to go to the previous page. + # → Command to go to the next page. + header: Transaction history (: Owned by '>) + + # All placeholders from ‘balance’ and ‘transfer-sent’ are available. + # Use ‘’ (no prefix) for your account and ‘other-’ prefix for the other account. # Additional placeholders: - # - The way the transfer was made, e.g. "direct transfer", "pos", etc. - # - Transaction date. You can use . Check here for patterns: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns - # - Full date with time zone. Can be used in , etc. + # → The way the transfer was made, e.g. ‘direct transfer’, ‘pos’, etc. + # → Transaction date. + # You can use ‘’. + # Check here for patterns: + # https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns + # → Full date with time zone. + # Can be used in , etc. entry: "'># <#4ade80> Owned by '>: ()" - # Same placeholders as header - footer: ">Previous page'>← Previous Page / >Next page'>Next →" - # No transactions - no-transactions: "(!) No transactions to show." - # Successfully created payment instrument (bank card) - instrument-created: "(!) Successfully created payment instrument." + # Same placeholders as ‘header’. + footer: >Previous page'>← Previous Page / >Next page'>Next → + + # No transactions. + no-transactions: (!) No transactions to show. + + # Successfully created a payment instrument (bank card). + instrument-created: (!) Successfully created payment instrument. - # Pos created - # Same placeholders as balance (account is that of the seller). + # POS created. + # All placeholders from ‘balance’ are available (the account is that of the seller). # Additional placeholders: - # - Price of the POS contents without formatting, example: 123456.78 - # - Price of the POS contents with formatting, example: 123,456.78 - # - Price of the POS contents with formatting, example: 123k - # - Bank statement description - # - X coordinate of the chest - # - Y coordinate of the chest - # - Z coordinate of the chest - # - World name of the chest - pos-created: "(!) Successfully created POS with price to receive in account : Owned by '>: " - - # Pos removed + # → Price of the POS contents without formatting, example: ‘123456.78’. + # → Price of the POS contents with formatting, example: ‘$123,456.78’. + # → Price of the POS contents with formatting, example: ‘$123k’. + # → Bank statement description. + # → X coordinate of the chest. + # → Y coordinate of the chest. + # → Z coordinate of the chest. + # → World name of the chest. + pos-created: (!) Successfully created POS with price to receive in account : Owned by '>: + + # POS removed. # (no placeholders) - pos-removed: "(!) Removed POS." + pos-removed: (!) Removed POS. - # Pos purchase completed - # Same placeholders as transfer-sent. `from` account is buyer, `to` account is seller. + # POS purchase completed. + # All placeholders from ‘transfer-sent’ are available. + # The ‘from’ account is the buyer, the ‘to’ account is the seller. # Additional placeholders: - # - Number of items purchased - # - E.g. `1 item`, `5 items`, etc. - # - POS coordinates, e.g. `X: 123 Y: -12 Z: 456 in world` - pos-purchase: "(!) Successfully purchased from Owned by '> for . You paid from : Owned by '>: " - - # Someone made a purchase from your POS - # Same placeholders as pos-purchase. `from` account is buyer, `to` account is seller. + # → Number of items purchased. + # → E.g. ‘1 item’, ‘5 items’, etc. + # → POS coordinates, e.g. ‘X: 123 Y: -12 Z: 456 in world’. + pos-purchase: (!) Successfully purchased from Owned by '> for . You paid from : Owned by '>: + + # Someone made a purchase from your POS. + # Same placeholders as ‘pos-purchase’. + # The ‘from’ account is the buyer, the ‘to’ account is the seller. # Additional placeholders: - # - Number of items purchased - # - E.g. `1 item`, `5 items`, etc. - # - POS coordinates, e.g. `X: 123 Y: -12 Z: 456 in world` - pos-purchase-seller: "(!) Sold to Owned by '> for at POS . The funds are in account : Owned by '>: " + # → Number of items purchased. + # → E.g. ‘1 item’, ‘5 items’, etc. + # → POS coordinates, e.g. ‘X: 123 Y: -12 Z: 456 in world’. + pos-purchase-seller: (!) Sold to Owned by '> for at POS . The funds are in account : Owned by '>: - # Account whois - # Same placeholders as balance + # Account ‘whois’ information. + # Same placeholders as ‘balance’. whois: |- Account Owned by: Type: ID: >Copy to clipboard'> - # Top balances + # Highest balances leaderboard. baltop: - # Baltop header + # Baltop header. # Placeholders: - # - Baltop category - # - Current page number - # - Command to go to previous page - # - Command to go to next page - header: "Baltop ()>Click'>← Previous Page >Click'>Next → " - # Baltop entry - # All placeholders from balance - # - leaderboard rank number - entry: ": Owned by '># " - # Baltop player entry + # → Baltop category. + # → Current page number. + # → Command to go to previous page. + # → Command to go to next page. + header: Baltop ()>Click'>← Previous Page >Click'>Next → + + # Baltop entry. + # All placeholders from ‘balance’ are available. + # Additional placeholders: + # → Leaderboard rank number. + entry: : Owned by '># + + # Baltop player entry. # Placeholders: - # - leaderboard rank number - # - Player UUID - # - Player username - # - Total balance without formatting, example: 123456.78 - # - Total balance with formatting, example: $123,456.78 - # - Total balance with formatting, example: $123k - entry-player: " >'># " + # → Leaderboard rank number. + # → Player UUID. + # → Player username. + # → Total balance without formatting, example: ‘123456.78’. + # → Total balance with formatting, example: ‘$123,456.78’. + # → Total balance with formatting, example: ‘$123k’. + entry-player: >'># # Invoices invoice: # Viewing an invoice # Placeholders: - # - Invoice ID - # - Invoice amount without formatting, example: 123456.78 - # - Invoice amount with formatting, example: $123,456.78 - # - Invoice amount with formatting, example: $123k - # - Invoice description - # - Date invoice was created. You can use . Check here for patterns: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns - # - The username of the player who is requested to pay the invoice. Can be "anyone" if anyone can pay this invoice - # - Invoice transaction ID (if the invoice is paid). If not paid, will be "unpaid" - # - Payment status (as defined below) - # - Button to pay the invoice (as defined below) - # - Seller account name. Defaults to owner username or ID if not set. - # - Seller account ID - # - Seller account type (Personal or Business) - # - Seller account owner username - # - Seller account balance without formatting, example: 123456.78 - # - Seller account balance with formatting, example: $123,456.78 - # - Seller account balance with formatting, example: $123k + # → Invoice ID. + # → Invoice amount without formatting, example: ‘123456.78’. + # → Invoice amount with formatting, example: ‘$123,456.78’. + # → Invoice amount with formatting, example: ‘$123k’. + # → Invoice description. + # → Date invoice was created. + # You can use ‘’. + # Check here for patterns: + # https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/format/DateTimeFormatter.html#patterns + # → The username of the player who is requested to pay the invoice. + # Can be ‘anyone’ if anyone can pay this invoice. + # → Invoice transaction ID (if the invoice is paid). + # If not paid, will show ‘unpaid’. + # → Payment status (as defined below). + # → Button to pay the invoice (as defined below). + # → Seller account name. + # Defaults to owner username or ID if not set. + # → Seller account ID. + # → Seller account type (Personal, Business, …). + # → Seller account owner username. + # → Seller account balance without formatting, example: ‘123456.78’. + # → Seller’s account balance with formatting, example: ‘$123,456.78’. + # → Seller’s account balance with formatting, example: ‘$123k’. details: |- INVOICE Click to copy'>># Amount: @@ -621,62 +608,138 @@ messages: Status: Description: - # Used in the placeholder - # Same placeholders as details (except ) + # Used in the placeholder. + # All placeholders from ‘details’ are available (except ). status: paid: "Paid (transaction #)" unpaid: Unpaid - # Used in the placeholder. This placeholder is an empty string if the invoice is unpaid. - # Same placeholders as details (except ) + # Used in the placeholder. + # This placeholder is always replaced with nothing if the invoice is already paid. + # All placeholders from ‘details’ are available (except ). pay-button: Click to pay'>>[PAY] - # You have received an invoice - # Same placeholders as details + # You have received an invoice. + # Same placeholders as ‘details’. received: >(!)You have received invoice Invoice #From For '># from Owned by '>. Click to view. - # Invoice successfully sent - # Same placeholders as details + # Invoice successfully sent. + # Same placeholders as ‘details’. sent: (!) Invoice # successfully sent. - # Invoice created - # Same placeholders as details + # Invoice created. + # Same placeholders as ‘details’. created: >(!) Successfully created invoice # for to from : '>. Click to view. - # Your invoice has been paid (seller's perspective) - # Same placeholders as details + # Your invoice has been paid (seller’s perspective). + # Same placeholders as ‘details’. paid-seller: >(!) Your invoice Invoice #For '># () has been paid. Click to view. - # You have successfully paid an invoice (buyer's perspective) - # Same placeholders as details + # You have successfully paid an invoice (buyer’s perspective). + # Same placeholders as ‘details’. paid-buyer: >(!) You have successfully paid invoice Invoice #By For '># (). Click to view. # List invoices list: - # Header + # Header. # Placeholders: - # - current page number - # - command to go to previous page - # - command to go to next page - header: "Invoices" + # → Current page number. + # → Command to go to the previous page. + # → Command to go to the next page. + header: Invoices - # Invoice entry - # Same placeholders as details + # Invoice entry. + # Same placeholders as ‘details’. entry: ># , Owned by '> - # Footer - # Same placeholders as details - footer: ">← Previous Page >Next →" + # Footer. + # Same placeholders as ‘header’. + footer: >← Previous Page >Next → - # You have unpaid invoices - # Sent periodically and on login (as configured in invoice.notify) - # Set to empty string to disable + # You have unpaid invoices. + # Sent periodically and on login (as configured in ‘invoice.notify’). + # Set to nothing, e.g. ‘notify:’ (without the quotes) to disable. # Placeholders: - # - number of unpaid invoices>." - # - choice placeholder for unpaid invoices; see https://docs.advntr.dev/minimessage/dynamic-replacements.html#insert-a-choice - notify: "(!) You have unpaid invoice. Click to view." + # → The number of unpaid invoices. + # → Choice placeholder for unpaid invoices. + # See: https://docs.advntr.dev/minimessage/dynamic-replacements.html#insert-a-choice + notify: (!) You have unpaid invoice. Click to view. - # New version available + # A new version of the plugin is available. # Placeholders: - # - New version - update-available: "Click to view update - Changelog & release notes - Download links'>>[BankAccounts] A new version has been released.Please update to get the latest bug fixes and features. > Click to view update" + # → The new BankAccounts version number, e.g. ‘1.10.1’. + update-available: Click to view update - Changelog & release notes - Download links'>>[BankAccounts] A new version has been released.Please update to get the latest bug fixes and features. > Click to view update + + # Error messages. + errors: + no-accounts: (!) You have no bank accounts. + no-permission: (!) You do not have permission to use this command. + account-not-found: (!) Account not found. + unknown-command: (!) Unknown command. Try help>/. + + # Placeholders: + # → The account type. + # → The account limit for that type. + max-accounts: (!) You cannot open more than accounts. + + rename-vault-account: (!) You cannot rename this account. + not-account-owner: (!) You are not the owner of this account. + frozen: (!) account () is frozen. This account cannot initiate or receive transactions. + same-from-to: (!) The ‘from’ and ‘to’ accounts must be different. + transfer-self-only: (!) You can only make transfers between your own accounts. + transfer-other-only: (!) You cannot make a transfer between your own accounts. + + # Invalid number was given. Placeholder is the invalid number. + invalid-number: (!) Invalid number: + + # $0 or negative transfer + negative-transfer: (!) The amount to transfer must be greater than zero. + + # Insufficient funds. All placeholders from ‘messages.balance’ are available. + insufficient-funds: (!) Your account has insufficient funds. You have + + closing-balance: (!) You cannot close an account that has a non-zero balance. This account has + player-only: (!) You must be a player to use this command. + player-not-found: (!) Player not found. + + # You must have a specific item to convert to an instrument. + # Placeholders: + # → The item type that is required (the item ID). + # → Item translation key, can be as ‘>’. + instrument-requires-item: (!) You must have x1 > in your inventory to create a bank card from. + + # Target player’s inventory is full. + # Placeholder is the target player’s name. + target-inventory-full: (!) The inventory of is full. + + block-too-far: (!) The targeted block is too far away. + pos-already-exists: (!) A POS already exists at this location. + pos-not-chest: (!) The targeted block is not a chest. + pos-double-chest: (!) The POS cannot be a double chest. + pos-empty: (!) The chest is empty. POS cancelled. + pos-invalid-card: (!) You need a valid bank card to use POS. + pos-no-permission: (!) You do not have permission to use POS. + no-card: (!) You must hold your bank card to use this. + pos-items-changed: (!) The items in the chest have changed. POS cancelled. + pos-create-business-only: (!) You can only create a POS with a business account. + + # Provided string includes disallowed characters + # Placeholder is the disallowed characters. + disallowed-characters: (!) The provided string contains disallowed characters: + + already-frozen: (!) This account is already frozen. + not-frozen: (!) This account is not frozen. + negative-invoice: (!) The amount to invoice must be greater than zero. + invoice-not-found: (!) Invoice not found. + invoice-pay-self: (!) You cannot pay your own invoice with the same account. You can use a different account. + invoice-already-paid: (!) This invoice has already been paid. + + # Cannot send this invoice to this player because either: + # a) the invoice has a set buyer and that’s not this player; OR + # b) the player does not have permission to view invoices not meant for them. + invoice-cannot-send: (!) You cannot send this invoice to that player because they don’t have permission to view it. + + player-never-joined: (!) This player has never joined this server. + async-failed: (!) The request failed. See the console for details. + delete-vault-account: (!) You cannot delete this account. + transfer-to-server-vault: (!) You cannot transfer funds to this account. This account is for internal use only.