update Readme and pom.

This commit is contained in:
Nick Minkler 2014-05-17 11:05:29 -07:00
parent b233d06c36
commit 9c0c063fea
2 changed files with 20 additions and 94 deletions

113
README.md
View File

@ -1,12 +1,23 @@
# Vault - Abstraction Library for Bukkit Plugin
# VaultAPI - Abstraction Library API for Bukkit Plugins
## Installing
Installing Vault is as simple as copying the provided "Vault.jar" to your
"<bukkit-install-dir>/plugins" directory and the rest is automatic! If you
wish to perform configuration changes, this can be done via a configuration
file but should not be necessary in most cases. See the "Advanced
Configuration" section for more information.
How to use with maven:
```
<repositories>
<repository>
<id>vault-repo</id>
<url>http://nexus.theyeticave.net/content/repositories/pub_releases</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>net.milkbowl.vault</groupId>
<artifactId>VaultAPI</artifactId>
<version>1.3.0.2</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
## Why Vault?
I have no preference which library suits your plugin and development efforts
@ -17,21 +28,8 @@ the idea for Vault came into play.
So, what features do I _think_ you'll like the most?
* No need to include my source code in your plugin
All of Vault is run in its own plugin, so all you need to do is obtain an
instance of it! This simplifies issues with multiple plugins using the same
namespaces. Just simply add Vault.jar to your download zip file!
* Broad range of supported plugins
I wanted an abstraction layer not only for Economic plugins but also
Permission plugins as well. The future will likely add more, but what
types, I have yet to decide, let me know!
* Choice!
That's half the fun of Bukkit, we get to choose what to use! More choice
has never hurt developers so here's to choice!
## Permissions
* vault.admin
- Determines if a player should recieve the update notices
## License
Copyright (C) 2011 Morgan Humes <morgan@lanaddict.com>
@ -50,80 +48,9 @@ You should have received a copy of the GNU Lesser General Public License
along with Vault. If not, see <http://www.gnu.org/licenses/>.
## Building
Vault comes with all libraries needed to build from the current branch and
also comes with an Apache Ant build file (build.xml).
VaultAPI comes with all libraries needed to build from the current branch.
## Dependencies
Because Vault provides a bridge to other plugins, their binaries will be
required to build from. To ease this, they have been included in the lib
folder and will be updated from time to time. For plugin developers, it
is not necessary to use these libraries when implementing Vault. You will
only need to compile against Vault.
## Supported Plugins
Vault provides abstraction for the following categories and plugins. If you
have your own plugin that you believe should be supported, fork Vault or create
a patch with the necessary changes. Additionally you can create an issue on
Github and we'll get to it at our convenience.
* Economy
- 3co (http://forums.bukkit.org/threads/22461/)
- AEco
- BOSEconomy 6 (http://forums.bukkit.org/threads/19025/)
- BOSEconomy 7
- CommandsEX Economy (http://dev.bukkit.org/server-mods/commandsex/)
- CraftConomy2 (http://dev.bukkit.org/server-mods/craftconomy/)
- CraftConomy3 (http://dev.bukkit.org/server-mods/craftconomy/)
- CurrencyCore (http://dev.bukkit.org/server-mods/currency/)
- Dosh
- EconXP (http://dev.bukkit.org/server-mods/econxp/)
- Essentials Economy (http://forums.bukkit.org/threads/15312/)
- eWallet (http://dev.bukkit.org/server-mods/ewallet/)
- GoldIsMoney
- GoldIsMoney2
- Gringotts
- iConomy 4 (http://forums.bukkit.org/threads/40/)
- iConomy 5 (http://forums.bukkit.org/threads/40/)
- iConomy 6 (http://forums.bukkit.org/threads/40/)
- McMoney
- Miconomy
- MineConomy (http://dev.bukkit.org/server-mods/mineconomy/)
- MineFaconomy2
- MultiCurrency
- SDFEconomy
- TAEcon
- XPBank
* Permissions
- bPermissions
- bPermissions 2 (http://dev.bukkit.org/server-mods/bpermissions/)
- DroxPerms
- Group Manager (Essentials) (http://forums.bukkit.org/threads/15312/)
- Permissions 3 (http://forums.bukkit.org/threads/18430/)
- PermissionsBukkit
- Permissions Ex (http://forums.bukkit.org/threads/18140/)
- Privileges
- rscPermissions
- SimplyPerms
- SuperPerms (Bukkit's default)
- TotalPermissions (http://dev.bukkit.org/bukkit-mods/totalpermissions)
- XPerms
- zPermissions
* Chat
- bPermissions
- Group Manager (Essentials)
- iChat
- mChat
- mChatSuite
- Permissions3
- PEX
- rscPermissions
- TotalPermissions
- zPermissions
## Implementing Vault
Implementing Vault is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit ServiceManager. See the example below:
@ -201,7 +128,7 @@ public class ExamplePlugin extends JavaPlugin {
if(command.getLabel().equals("test-economy")) {
// Lets give the player 1.05 currency (note that SOME economic plugins require rounding!)
sender.sendMessage(String.format("You have %s", econ.format(econ.getBalance(player.getName()))));
EconomyResponse r = econ.depositPlayer(player.getName(), 1.05);
EconomyResponse r = econ.depositPlayer(player, 1.05);
if(r.transactionSuccess()) {
sender.sendMessage(String.format("You were given %s and now have %s", econ.format(r.amount), econ.format(r.balance)));
} else {

View File

@ -90,7 +90,6 @@
<author>true</author>
<version>true</version>
<linksource>true</linksource>
<excludePackageNames>net.milkbowl.vault.chat.plugin:net.milkbowl.vault.economy.plugin:net.milkbowl.vault.permission.plugin</excludePackageNames>
<bottom><![CDATA[<b>Milkbowl, 2014</b>]]></bottom>
</configuration>
</plugin>