# EmeraldBank - A Simple Emerald Economy Plugin A simple and lightweight economics plugin using Emerald. All messages and configurations are customizable in `config.yml`. ## Dependencies - [Paper](https://papermc.io/) - [Vault](https://github.com/MilkBowl/Vault/releases) ### Optional Dependencies - [OpenInv](https://github.com/Jikoo/OpenInv/releases) ## MC Version Policy EmeraldBank basically supports latest version of Minecraft. However, we will support the previous version for a while. We will not support the version that is no longer supported by PaperMC. The following table shows the support status of each version. | Version | Support | |---------------|--------------------------------| | 1.21.5 | ✅ Active support | | 1.21.4 | ✅ Active support | | 1.21 ~ 1.21.3 | 🔁 May work, but not supported | | < 1.20.X | 🚧 No longer supported | ## Commands - `/bank` Alias of `/emeraldbank bank` - `/balance` Alias of `/emeraldbank balance` - `/pay` Alias of `/emeraldbank pay` - `/wallet` Alias of `/emeraldbank wallet` - `/em` Alias of `/emeraldbank` - `/embank` Alias of `/emeraldbank` - `/emeraldbank balance` Show your balance that count of emeralds you have. - `/emeraldbank balance ` Show other player's balance. - `/emeraldbank leaderboard` Show all player's balance in leaderboard. - `/emeraldbank pay ` Pay emeralds to other player. - `/emeraldbank reload` Reload config and messages - `/emeraldbank wallet add ` Add emeralds to your wallet. - `/emeraldbank wallet add all` Add all emeralds to your wallet. - `/emeraldbank wallet withdraw ` Withdraw emeralds from your wallet. - `/emeraldbank wallet balance` Show your wallet balance. - `/emeraldbank bank account create ` Create a new bank account. - `/emeraldbank bank account delete ` Close the specified bank account. - `/emeraldbank bank account add ` Add a member that can access the bank account. - `/emeraldbank bank account remove ` Remove a member from the bank account. - `/emeraldbank bank account addowner ` Add an owner that can manage the bank account. - `/emeraldbank bank account removeowner ` Remove an owner from the bank account. - `/emeraldbank bank account list` Show all bank accounts. - `/emeraldbank bank account list ` Show all members of bank. - `/emeraldbank bank balance ` Show bank balance. - `/emeraldbank bank deposit ` Deposit to the bank account. - `/emeraldbank bank withdraw ` Withdraw to the bank account. - `/emeraldbank bank send ` Transfer emeralds to other bank account. - `/emeraldbank bank pay ` Pay emeralds to specified player. ## Permissions - `emeraldbank.admin` - `emeraldbank.balance.all` - `emeraldbank.reload` - `emeraldbank.currency.rate.set` - `emeraldbank.bypass` - `emeraldbank.bypass.cost` - `emeraldbank.bypass.deposit` - `emeraldbank.bypass.member` - `emeraldbank.bypass.owner` - `emeraldbank.default` - `emeraldbank.balance` - `emeraldbank.pay` - `emeraldbank.leaderboard` - `emeraldbank.banking` - `emeraldbank.banking` - `emeraldbank.banking.balance` - `emeraldbank.banking.deposit` - `emeraldbank.banking.withdraw` - `emeraldbank.banking.send` - `emeraldbank.banking.pay` - `emeraldbank.banking.account` - `emeraldbank.banking.account` - `emeraldbank.banking.account.create` - `emeraldbank.banking.account.delete` - `emeraldbank.banking.account.add` - `emeraldbank.banking.account.remove` - `emeraldbank.banking.account.list` - `emeraldbank.banking.account.transfer` - `emeraldbank.currency` - `emeraldbank.currency.rate` - `emeraldbank.currency.exchange` - `emeraldbank.currency.exchange.` - `emeraldbank.currency.exchange.*` - `emeraldbank.currency.rate` - `emeraldbank.currency.rate.get` ## Placeholders - `%emeraldbank_balance%` - `%emeraldbank_balance_%` - `%emeraldbank_wallet%` - `%emeraldbank_wallet_%` - `%emeraldbank_bank_balance_%` - `%emeraldbank_bank_owner_%` - `%emeraldbank_bank_members_%` - `%emeraldbank_bank_list%` ## Configuration ```yaml # ______ _ _ ____ _ # | ____| | | | | _ \ | | # | |__ _ __ ___ ___ _ __ __ _| | __| | |_) | __ _ _ __ | | __ # | __| | '_ ` _ \ / _ | '__/ _` | |/ _` | _ < / _` | '_ \| |/ / # | |____| | | | | | __| | | (_| | | (_| | |_) | (_| | | | | < # |______|_| |_| |_|\___|_| \__,_|_|\__,_|____/ \__,_|_| |_|_|\_\ # # # DO NOT CHANGE THIS VALUE! config_version: 1 # The cost for paying a player. pay-cost: disabled ################################################################# ## # ## Banking # ## # ################################################################# banking: # Enable or disable banking. enabled: true tax: # The cost for creating a bank. create-cost: disabled # The cost for creating a bank. add-member-cost: disabled # The cost for removing a member from a bank. transfer-bank-cost: disabled # The cost for sending from a bank to another bank. deposit-cost: disabled # The cost for withdrawing from a bank. withdraw-cost: disabled # The cost for paying from a bank to a player. pay-cost: disabled # The default destination for payments. # INVENTORY: The player's inventory. # WALLET: The player's wallet. default-destination: INVENTORY # Load offline players' inventories. # This setting requires OpenInv (https://github.com/Jikoo/OpenInv). # Change of this setting will require a restart of the server. load-offline-players-inventories: false # Enable or disable the exchange feature. # WARNING: This setting is experimental feature. # This setting may change in the future. exchange-enabled: false ################################################################# ## # ## Currencies # ## # ################################################################# # The currencies used in the plugin. # WARNING: Changing this setting is experimental feature. # This setting may change in the future. # You should not change this setting unless you know what you are doing. currencies: emerald: # The name of the currency. name: Emerald # The plural name of the currency. name-plural: Emeralds # Use this currency as the default currency. default-currency: true # The rate of the currency. rate: 1.0 # The item type of the currency. item-type: emerald # The children item type and rate of the currency. children: emerald_block: 9 # The cost for exchanging. cost: disabled ################################################################# ## # ## Database # ## # ################################################################# database: # The type of database to use. # Change of database type will require a restart of the server. # H2: H2 Database # MYSQL: MySQL Database type: H2 # The host of the database. host: localhost # The port of the database. port: 3306 # The name of the database. database: emeraldbank # The username of the database. username: root # The password of the database. password: password ################################################################# ## # ## Messages # ## # ################################################################# messages: name: EmeraldBank reload: Reloaded configuration and messages economy-format: balance: '''s Balance: (Wallet: )' balance-bank: '''s Balance: ' leaderboard: ': ' rate-value: 'rate: ' rate-value-of-currency: 'Rate of : ' set-rate: Set rate of to exchange-rate: 'Exchange rate: 1 = ' exchange-cost: 'Exchange cost: ' exchange-receive: 'Estimated exchange amount: ' exchange-start: Exchanging to pay-success: Successfully paid to error-pay: Failed to pay to error-pay-self: You cannot pay yourself! banking-create: Created bank banking-delete: Deleted bank banking-deposit: Deposited to banking-withdraw: Withdrew from banking-add-member: Added to bank banking-remove-member: Removed from bank banking-list: 'Banks: ' banking-members: 'Members of : ' banking-add-owner: Added as owner of bank ! banking-remove-owner: Removed as owner of bank ! banking-send: Sent from to banking-pay: Paid from bank to offline-transaction: has been moved to your balance while you were offline! wallet: '''s Wallet: ' add-wallet: Added to 's wallet! withdraw-wallet: Withdrew from 's wallet! received: Received from receive-bank: Received to bank from error-banking-disabled: Banking is disabled! error-banking-create: Failed to create bank ! error-banking-delete: Failed to delete bank ! error-banking-exists: Bank already exists! error-banking-no-bank: Bank does not exist! error-banking-deposit: Failed to deposit to error-banking-withdraw: Failed to withdraw from error-banking-not-owner: is not the owner of bank ! error-banking-not-member: is not a member of bank ! error-banking-member-exists: is already a member of bank ! error-banking-add-member: Failed to add to bank ! error-banking-remove-member: Failed to remove from bank ! error-banking-delete-remaining: Bank has a remaining balance of ! error-banking-send: Failed to send from bank to bank ! error-banking-pay: Failed to pay from bank to ! error-banking-remove-owner: is the owner of bank ! error-banking-create-cost: Failed to create bank due to insufficient funds ! error-banking-add-member-cost: Failed to add member to bank due to insufficient funds ! error-banking-transfer-cost: Failed to transfer bank to due to insufficient funds ! error-banking-deposit-cost: Failed to deposit to bank due to insufficient funds ! error-banking-withdraw-cost: Failed to withdraw from bank due to insufficient funds ! error-banking-pay-cost: Failed to pay from bank to due to insufficient funds ! error-pay-cost: Failed to pay to due to insufficient funds ! error-add-wallet: Failed to add to 's wallet! error-withdraw-wallet: Failed to withdraw from 's wallet! error-reload: Failed to reload configuration and messages! error-banking-remove-last-owner: Failed to remove as owner of bank ! error-banking-remove-last-member: Failed to remove as member of bank ! error-player-not-found: Player not found! error-same-currency: You cannot exchange the same currency ! error-currency-not-found: Currency not found! error-not-enough-currency: You do not have of to pay! error-no-permission: You do not have permission to do this! error-exchange-too-low: Exchange amount is too low! ``` --- ## Change Log ### 1.1.0 - Currencies are now modifiable in `config.yml` (experimental feature) - Added support for multiple currencies (experimental feature) - Added support for exchange rates (experimental feature) - Removed data migration feature for pre 1.0.0 versions (aka `0.X.X` versions) ### 1.0.0 - Initial release

ikafly144

EmeraldBank

SlotMachine

MailBox