.: MineConomy Readme File :.
-= Table of Contents =-
-= Introduction =-
MineConomy is a mid-weight, simple Bukkit Economy Plugin.
If you need more help than is in this readme file, please go to the MineConomy Plugin page (http://dev.bukkit.org/server-mods/MineConomy) for more information and tutorials.
NOTICE: Do NOT edit the accounts.yml or banks.yml save files. This will result in MineConomy corruption.
-= Config File =-
The Config file is in the MineConomy folder as config.yml.
Starting Balance: This will be the amount of money that all accounts will have when they are created.
Max Debt: This is the maximum amount of debt an account can have on your server. Leave at 0 to disallow debt.
Display GUI: This may be set to "true" (enabling) or "false" (disabling). Determines whether to show the MineConomy GUI on the server host computer.
Amount: This is the amount of interest given to all accounts on the server.
Interval: This is the amount of time (in seconds) between when interest will be applied to accounts. This must be a natural number. The smaller this number is, the more strain there will be on the server. Set to 0 to disable interest.
Mode: This is the mode that interest will be taken in. This field can be set as "fixed", which will give accounts the Interest-Amount. This field can also be set as "percent", which will give accounts the percentage from Interest-Amount based on their balance. To have no interest, set this field to "none".
Amount: This is the amount of tax taken from all the accounts on the server.
Interval: This is the amount of time (in seconds) between when tax will be applied to accounts. This must be a natural number. The smaller this number is, the more strain there will be on the server. Set to 0 to disable tax.
Mode: This is the mode that tax will be taken in. This field can be set as "fixed", which takes the Interest-Amount. This field can also be set as "percent", which will take the percentage from Interest-Amount from accounts based on their balance. To have no tax, set this field to "none".
-= Currencies File =-
The Currencies file is in the MineConomy folder as currencies.yml.
Dollars: The name of the MineConomy currency
Value: 1.0 The value of the currency
Default: true Whether this currency is the default of MineConomy
exp: The name of the physical currency
Value: 2.0 The currency's value
ID: _exp The currency's MineConomy ID*
wood: The name of the physical currency
Value: 1.0 The currency's value
ID: '5' The Minecraft Item ID number of this physical currency surrounded by single-quotes.
* ID's with underscores ('_') before them are special items, such as Experience.
-= Commands =-
< > - Required Field
[ : ] - Option Field
( ) - Unrequired Field
/mc - displays balance
/mc balance - displays balance
/mc help - displays in-game help menu
/mc set <ACCOUNT> <AMOUNT> - sets specified account's balance
/mc get <ACCOUNT> - displays specified account's balance
/mc pay <ACCOUNT> <AMOUNT> - pays specified account the specified amount
/mc create <ACCOUNT> - creates new account with specified name
/mc delete <ACCOUNT> - deletes specified account
/mc give <ACCOUNT> <AMOUNT> - gives specified account the specified amount
/mc take <ACCOUNT> <AMOUNT> - takes specified amount from the specified account
/mc empty <ACCOUNT> - sets the specified account's balance to 0
/mc deposit <AMOUNT> - deposits specified amount of physical currency into your account
/mc withdraw <AMOUNT> - withdraws specified amount of physical currency from your account
/mc exp - displays your amount of experience
/mc top <SIZE> - displays the richest accounts on the server
/mc setcurrency (ACCOUNT) <CURRENCY> - sets specified account's currency
/mc save - saves all MineConomy data
-= Permission Nodes =-
mineconomy.* - allows users full access to MineConomy (Not recommended)
mineconomy.account.* - allows users full access to this permission branch (Recommended for admins)
mineconomy.account.have - allows users to have accounts
mineconomy.account.create - allows users to create other accounts
mineconomy.account.delete - allows users to delete other accounts
mineconomy.balance.* - allows users full access to this permission branch (Recommended for admins)
mineconomy.balance.check - allows users to check their own balances
mineconomy.balance.get - allows users to get another account's balance
mineconomy.balance.set - allows users to set another account's balance
mineconomy.balance.pay - allows users to pay other users
mineconomy.balance.give - allows users to give money to other accounts
mineconomy.balance.take - allows users to take money away from another account
mineconomy.balance.empty - allows users to set another account's balance to 0
mineconomy.balance.deposit - allows users to deposit physical currency into their account
mineconomy.balance.withdraw - allows users to withdraw physical currency from their account
mineconomy.currency.* - allows users full access to this permission branch (Recommended for admins)
mineconomy.currency.set - allows users to set their own account currency
mineconomy.currency.set.others - allows users to set other accounts' currencies
mineconomy.help - allows users to have the in-game help menu displayed to them.
-= GUI =-
Choose an account from the left and the balance will be displayed.
Enter an amount in the text field to either 'give', 'take' or 'set' from that account.
Also you can 'empty' (set balance to 0) or 'delete' the selected account.
The lower text field can create an account. Enter the account name and click 'create account'.
You may also 'stop' or 'reload' the server.
Finally, you may 'check for updates' to MineConomy.
-= Change Log =-
- Version 1.1 -
* Properties changed to Config (YML)
* ExteriorPlugin class changed to MCCom
* MCPlayerListener class changed to MCListener
* MCCommandExecutor class changed to ChatExecutor
* Internal classes accessed through MCCom (An Added Safety Precaution)
* Updates to implement currencies
* In-Game Save Command
* Auto Update deprecated, Update check is unchanged
* GUI No Longer Reloads Server
* Welcome Message Fix
* Top Command
* Updated to Minecraft 1.2.3
* Banks system added (not yet implemented)
- Version 1.0.4 -
* Colored Balances (Based on Pos/Neg Balance)
* Tax/Interest (Optional/Configurable)
* Auto Generate Readme
* Organization for Properties File (Alphabetic)
* Welcome Message on Login
* "/money" Command Label acts the same as "/mc" Command Label
* Auto Update Feature
* Server-side GUI (Optional)
* Experience as a Physical Currency (Optional)
* Support for more future physical currencies
* Added further support for Exterior Plugins
- Version 1.0.3 -
* Give Command Fix
- Version 1.0.2 -
* "Empty" Node Fix
* New Class Added (IOH) - Streamlines Log Code
- Version 1.0 -
* Basic Structure Added
* Basic Features Added
Last Edited: Sat Mar 24, 2012 4:00PM