Upstream/VaultAPI
1
0
Fork 0
mirror of https://github.com/MilkBowl/VaultAPI.git synced 2024-09-27 06:42:44 +02:00
Code Issues Projects Releases Wiki Activity

spelling/grammar/spacing fixes

Browse Source
This commit is contained in:
Jack Fitch 2022-06-28 14:47:40 -04:00
parent 9520d8847e
commit 52b8f72f15
No known key found for this signature in database
GPG Key ID: 753BA18D9DE77C27
1 changed files with 98 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
README.md
View File

@ -1,6 +1,6 @@
# VaultAPI - Abstraction Library API for Bukkit Plugins - [![](https://travis-ci.org/MilkBowl/VaultAPI.svg?branch=master)](https://travis-ci.org/MilkBowl/VaultAPI) # VaultAPI - Abstraction Library API for Bukkit Plugins - [![](https://travis-ci.org/MilkBowl/VaultAPI.svg?branch=master)](https://travis-ci.org/MilkBowl/VaultAPI)
How to include the API with Maven: How to include the API with Maven:
```xml ```xml
<repositories> <repositories>
<repository> <repository>
@ -8,6 +8,7 @@ How to include the API with Maven:
<url>https://jitpack.io</url> <url>https://jitpack.io</url>
</repository> </repository>
</repositories> </repositories>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>com.github.MilkBowl</groupId> <groupId>com.github.MilkBowl</groupId>
@ -23,24 +24,25 @@ How to include the API with Gradle:
repositories { repositories {
maven { url 'https://jitpack.io' } maven { url 'https://jitpack.io' }
} }
dependencies { dependencies {
compileOnly "com.github.MilkBowl:VaultAPI:1.7" compileOnly "com.github.MilkBowl:VaultAPI:1.7"
} }
``` ```
**Note**: The VaultAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2 numbers in the VaultAPI will always correspond to the 2 beginning numbers in a Vault version to make it clear what versions your plugin will for sure work with. **Note**: The VaultAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2 numbers in the VaultAPI will always correspond to the 2 beginning numbers in a Vault version to make it clear what versions your plugin will work with.
## Why Vault? ## Why Vault?
I have no preference which library suits your plugin and development efforts I have no preference which library suits your plugin and development efforts
best. Really, I thought a central suite (rather...Vault) of solutions was the best. Really, I thought a central suite (rather...Vault) of solutions was the
the proper avenue than focusing on a single category of plugin. That's where proper avenue than focusing on a single category of plugin. That's where
the idea for Vault came into play. the idea for Vault came into play.
So, what features do I _think_ you'll like the most? So, what features do I _think_ you'll like the most?
* No need to include my source code in your plugin * No need to include my source code in your plugin
* Broad range of supported plugins * Broad range of supported plugins
* Choice! * Choice!
## License ## License
Copyright (C) 2011-2018 Morgan Humes <morgan@lanaddict.com> Copyright (C) 2011-2018 Morgan Humes <morgan@lanaddict.com>
@ -52,11 +54,11 @@ the Free Software Foundation, either version 3 of the License, or
Vault is distributed in the hope that it will be useful, Vault is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with Vault. If not, see <http://www.gnu.org/licenses/>. with Vault. If not, see <https://www.gnu.org/licenses/>.
## Building ## Building
VaultAPI comes with all libraries needed to build from the current branch. VaultAPI comes with all libraries needed to build from the current branch.
@ -81,93 +83,93 @@ import org.bukkit.plugin.RegisteredServiceProvider;
import org.bukkit.plugin.java.JavaPlugin; import org.bukkit.plugin.java.JavaPlugin;
public class ExamplePlugin extends JavaPlugin { public class ExamplePlugin extends JavaPlugin {
private static final Logger log = Logger.getLogger("Minecraft");
private static Economy econ = null;
private static Permission perms = null;
private static Chat chat = null;
@Override private static final Logger log = Logger.getLogger("Minecraft");
public void onDisable() { private static Economy econ = null;
log.info(String.format("[%s] Disabled Version %s", getDescription().getName(), getDescription().getVersion())); private static Permission perms = null;
} private static Chat chat = null;
@Override @Override
public void onEnable() { public void onDisable() {
if (!setupEconomy() ) { log.info(String.format("[%s] Disabled Version %s", getDescription().getName(), getDescription().getVersion()));
log.severe(String.format("[%s] - Disabled due to no Vault dependency found!", getDescription().getName())); }
getServer().getPluginManager().disablePlugin(this);
return; @Override
} public void onEnable() {
setupPermissions(); if (!setupEconomy() ) {
setupChat(); log.severe(String.format("[%s] - Disabled due to no Vault dependency found!", getDescription().getName()));
} getServer().getPluginManager().disablePlugin(this);
return;
private boolean setupEconomy() { }
if (getServer().getPluginManager().getPlugin("Vault") == null) { setupPermissions();
return false; setupChat();
} }
RegisteredServiceProvider<Economy> rsp = getServer().getServicesManager().getRegistration(Economy.class);
if (rsp == null) { private boolean setupEconomy() {
return false; if (getServer().getPluginManager().getPlugin("Vault") == null) {
} return false;
econ = rsp.getProvider(); }
return econ != null; RegisteredServiceProvider<Economy> rsp = getServer().getServicesManager().getRegistration(Economy.class);
} if (rsp == null) {
return false;
private boolean setupChat() { }
RegisteredServiceProvider<Chat> rsp = getServer().getServicesManager().getRegistration(Chat.class); econ = rsp.getProvider();
chat = rsp.getProvider(); return econ != null;
return chat != null; }
}
private boolean setupChat() {
private boolean setupPermissions() { RegisteredServiceProvider<Chat> rsp = getServer().getServicesManager().getRegistration(Chat.class);
RegisteredServiceProvider<Permission> rsp = getServer().getServicesManager().getRegistration(Permission.class); chat = rsp.getProvider();
perms = rsp.getProvider(); return chat != null;
return perms != null; }
}
private boolean setupPermissions() {
public boolean onCommand(CommandSender sender, Command command, String commandLabel, String[] args) { RegisteredServiceProvider<Permission> rsp = getServer().getServicesManager().getRegistration(Permission.class);
if(!(sender instanceof Player)) { perms = rsp.getProvider();
log.info("Only players are supported for this Example Plugin, but you should not do this!!!"); return perms != null;
return true; }
}
public boolean onCommand(CommandSender sender, Command command, String commandLabel, String[] args) {
Player player = (Player) sender; if(!(sender instanceof Player)) {
log.info("Only players are supported for this Example Plugin, but you should not do this!!!");
if(command.getLabel().equals("test-economy")) { return true;
// 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, 1.05); Player player = (Player) sender;
if(r.transactionSuccess()) {
sender.sendMessage(String.format("You were given %s and now have %s", econ.format(r.amount), econ.format(r.balance))); if(command.getLabel().equals("test-economy")) {
} else { // Lets give the player 1.05 currency (note that SOME economic plugins require rounding!)
sender.sendMessage(String.format("An error occured: %s", r.errorMessage)); sender.sendMessage(String.format("You have %s", econ.format(econ.getBalance(player.getName()))));
} EconomyResponse r = econ.depositPlayer(player, 1.05);
return true; if(r.transactionSuccess()) {
} else if(command.getLabel().equals("test-permission")) { sender.sendMessage(String.format("You were given %s and now have %s", econ.format(r.amount), econ.format(r.balance)));
// Lets test if user has the node "example.plugin.awesome" to determine if they are awesome or just suck } else {
if(perms.has(player, "example.plugin.awesome")) { sender.sendMessage(String.format("An error occured: %s", r.errorMessage));
sender.sendMessage("You are awesome!"); }
} else { return true;
sender.sendMessage("You suck!"); } else if(command.getLabel().equals("test-permission")) {
} // Lets test if user has the node "example.plugin.awesome" to determine if they are awesome or just suck
return true; if(perms.has(player, "example.plugin.awesome")) {
} else { sender.sendMessage("You are awesome!");
return false; } else {
} sender.sendMessage("You suck!");
} }
return true;
public static Economy getEconomy() { } else {
return econ; return false;
} }
}
public static Permission getPermissions() {
return perms; public static Economy getEconomy() {
} return econ;
}
public static Chat getChat() {
return chat; public static Permission getPermissions() {
} return perms;
}
public static Chat getChat() {
return chat;
}
} }
``` ```