ATM
Please note: this plugin requires an ECONOMY PLUGIN in order to display bank balances etc. This plugin will NOT provide you with an economy system
Features
- Check the balance of your bank at a click!
- Check your in-hand balance, too.
- Add global ATM signs - whoever clicks the sign gets their bank balance.
- Multi-bank support!
- Supports: iConomy (4, 5 & 6), BOSEconomy, Essentials Economy.
- Withdraw/deposit money using banks!
- Charge users to withdraw/deposit! (optional/configurable)
- Transfer money to other players.
- Transfer money into other player's bank accounts.
- Checks for new versions every time it starts up! (optional)
Screenshot
See Images tab.
How To Use
When creating a sign to check a bank, you must follow this format for ATM to recognize the sign:
[ATM] Personal/Global <bank_name> <blank>
Line 1: This must ALWAYS be "[ATM]" (without quotes). No colours or other characters allowed.
Line 2: Personal signs will only work for you. When you place a Personal ATM sign, the Personal line will change to your name, to show that it belongs to you. If you have the permissions to place a Global sign, this will allow all users to view their balances for a defined bank.
Line 3: This is the name of the bank you want to get the balance readouts from (case sensitive). If the bank does not exist, the sign will still be placed, but it will not be activated.
Line 4: You can put text on this line, but it will get updated with an [Active] flag to show that the ATM sign is active.
For example:
[ATM] Personal BigBank
This sign will produce a personal sign for the player who placed it, to access the balance of their account with BigBank.
[ATM] Global SmallerBank
This sign will produce a Global sign for anyone to use, to access their balance of their account with SmallerBank.
When creating a sign to view your in-hand balance, use this format:
[ATM] Private <blank> <blank>
This will update the third line to include your name, and the fourth line to include "[Active]". This sign will let you (and only you) see your in-hand balance.
To create a GLOBAL PRIVATE sign (i.e. a Private sign that lets anyone check their in-hand balance), use this format:
[ATM] Global [Private] <blank>
Note: the third line MUST have square brackets around it. If you input "Private" (without quotes) it will check for a bank called Private.
To create a sign for withdrawals, use this format:
[ATM] Withdraw:<number> <bank_name> <blank>
Replace <number> with how much you want to withdraw from the account. Follow the same format for deposits, but replace Withdraw with Deposit. Note: Make sure there are no spaces in the second line.
To create a transfer sign, use this format:
[ATM] Transfer <playername>:<amount> <blank>
Replace <amount> with how much you want to transfer. <playername> is the name of the player to transfer to. If you want to set up a sign for people to transfer to you, simply put your name where it says <playername>
To create a sign to transfer money into a player's bank account, use this format:
[ATM] BankTransfer <playername>:<bank> <amount>
If done correctly, the sign will update so that the second line is now <playername>:<bank>, the third line is <amount>, and the fourth line is a white [Active] tag.
To use a sign, simply right click it.
Configuration
The configuration file properties.yml will be generated with the default values:
enableCharges: false chargePercentage: true depositCharge: 2.5 withdrawCharge: 5 checkVersion: true
- enableCharges - when set to false, players will not be charged for withdrawals/deposits. When set to true, players will be charged.
- chargePercentage - when set to true, this will charge users a percentage of their transaction. When set to false, this will charge users a defined amount. For example, if this is set to true, and depositCharge is set to 2.5, users will be charged 2.5% of their transaction. Otherwise, it would charge them 2.5 of the currency.
- depositCharge - defines how much is charged for a deposit.
- withdrawCharge - defines how much is charged for a withdrawal.
- checkVersion - When true, ATM will automatically check for new versions and inform you of an update. When false, this is turned off.
Permissions
If you have Permissions by TheYeti installed, you can use these permission nodes. Otherwise, the plugin will read from ops.txt, and allow Personal and Private signs for anyone, and Global signs for anyone in ops.txt
- 'atm.place.Personal' - this permission allows the user/group to place Personal signs.
- 'atm.place.Global' - this permission allows the user/group to place Global signs.
- 'atm.place.Private' - this permission allows the user/group to place Private signs.
- 'atm.place.Withdraw' - this permission allows the user/group to place Withdraw signs.
- 'atm.place.Deposit' - this permission allows the user/group to place Deposit signs.
- 'atm.place.Transfer' - this permission allows the user/group to place Transfer signs.
- 'atm.place.BankTransfer' - this permission allows the user/group to place Bank Transfer signs.