BKCommonLib
BKCommonLib is no longer being updated on dev.bukkit.org.
If you want to use the latest version, use spigot.
Latest version: 1.57
CraftBukkit/SportBukkit/Spigot/MCPC+ build: CB 1.6.4 R1.0 / CB 1.6.4 R2.1 / Spigot 1.7
Older builds available: CB 1.5.2-R1.0 / CB 1.6.2-R1.0
Tekkit: Untested and thus unsupported, some features may not work as expected
Description
This utility library shares all the common code needs for various plugins, and having them in one library heavily reduces the amount of duplicated code. The featured utilities are varied, and whenever something is missing in Bukkit, it is added in BKCommonLib. This is one of the reasons why it has become this large: there are simply a lot of things Bukkit doesn't (want to) offer.
BKCommonLib has versioning on a per-plugin basis, so when a certain plugin needs version 2, and version 1 is installed, the server owner is automatically notified and the plugin is not enabled. This prevents the common mishaps with outdated BKCommonLib versions.
Other than utilities and services, this library offers a wide variety of reflection and user-friendly ways of accessing net.minecraft.server. If your plugin requires the use of the internals, but do not want to risk changing field and method names, you can depend on BKCommonLib to provide them for you. This allows you to remain compatible between CraftBukkit versions automatically, and reduces silent failure hazards.
Reasons for you to depend on this library
- You need to access Minecraft internals in your plugin, and Bukkit has no API for it
- You are tired of re-uploading the same version over again because of the internals changing
- You want to work with Vector/math logic, or need to use other utility classes
- The YAML of Bukkit dislikes you, and you want this to be easier
- You want to easily read and write configuration/data files
- You want easy access to data conversion utilities to convert user input
- You want to work with inventories in an advanced fashion
- You want to work with unique server events
- You want to alter entity behaviour (such as handling block collisions, custom movement, etc.)
- You want plugin messages/permissions to be configurable
- You want to work with (async)tasks without storing IDs
- You want to send and manipulate packets
Features
- General
- PluginBase for easy access to metrics, permissions, localization and more
- Permission defaults for storing the permissions a plugin uses
- Localization for making the messages of a plugin configurable
- Utilities
- General utilities for String, Logic, BlockFace and Math operations
- Block utilities for Block-related operations (states, data, etc.)
- ItemUtil for Inventory, Items and Item Transfer utilities
- RecipeUtil to work with crafting and furnace recipes
- Various Collections for auto-filtering, converting and even interpolation
- Data storage
- Configuration API with nodes, headers and other goodies
- NBT API designed after the configuration API
- (Compressed)DataReader/DataWriter to read and write data from/to file
- Entities
- CommonEntity implementations with added utilities
- EntityController for altering entity behaviour
- EntityNetworkController for altering entity network logic
- Services
- Metrics for keeping track of plugin statistics
- Conversion for conversions between all types of data
- Events and Listeners to keep track of changes on the server
- Packet services and API to keep track of packets
- Task class for easier task scheduling
- Scoreboard services to setup scoreboards without criteria
- Tab View service to alter what is shown when players press tab
Getting started
To start using BKCommonLib, you have two options (after adding BKCommonLib as dependency in the plugin.yml):
Include the jar file as a dependency
Like any dependency, keep the jar file somewhere on your computer and add it to your classpath. Nothing special here.
Make a (new) maven project and include it
Add the following repository:
<repository> <id>dj-tcraft repository</id> <url>http://ci.dj-tcraft.nl/plugin/repository/everything/</url> </repository>
And the following dependency (may need to update version):
<dependency> <groupId>com.bergerkiller.bukkit</groupId> <artifactId>BKCommonLib</artifactId> <version>1.54-SNAPSHOT</version> <scope>provided</scope> </dependency>
Dependencies BKCommonLib uses
BKCommonLib supports various other plugins and projects. Below all of these are listed:
- Vault - for permission plugin support
- ProtocolLib - to avoid packet listening conflicts
- Showcase(Standalone) - to ignore showcased items
- HyperConomy - to ignore shop items
- BleedingMobs - to ignore particles
- CGLib - for generating nms.Entity classes on-the-fly to supply Entity Controllers
- Objenesis - for generating classes without calling constructors (needed for various fixes inside class constructors)
Plugins that require BKCommonLib to be installed:
Disclaimer
This plugin utilises Hidendra's plugin metrics system, which means that the following information is collected and sent to mcstats.org:
- A unique identifier
- The server's version of Java
- Whether the server is in offline or online mode
- The plugin's version
- The server's version
- The OS version/name and architecture
- The core count for the CPU
- The number of players online
- The Metrics version Opting out of this service can be done by editing plugins/Plugin Metrics/config.yml and changing opt-out to true.
License
This library uses an open license. Feel free to use whatever code you need from it, you do not have to ask me either. If you want me to add certain features, that is fine too. Everyone is allowed to use this Library as a dependency. I do recommend extending 'PluginBase' instead of 'JavaPlugin' then, as it allows you to automatically deal with the BKCommonLib versioning checks. See also: BKCommonLib license file
This product includes software developed by the Apache Software Foundation (http://www.apache.org/)
Links:
Compatibility
BKCommonLib supports ProtocolLib when it is enabled, but if it is not, the player connection is replaced resulting in several incompatibilities. To fix these incompatibility issues, install ProtocolLib next to BKCommonLib. This can not be stressed enough. When incompatibility occurs, BKCommonLib will notify you in the console and will disable itself. The following plugins are known to be incompatible when ProtocolLib is NOT installed:
Metrics
This plugin sends server count and dependency statistics to MCStats.org. You can (globally) opt out in the PluginMetrics/config.yml file.
Banner
I use a banner in my depending plugins. This banner is automatically updated when a new version of BKCommonLib is out. It is a quick and efficient way to keep track of updates for this library. This was needed, too, because a lot of people were using outdated BKCommonLib versions, which resulted in bug reports...too many of them. And I do not want to waste your time with invalid reports. You have a plugin that uses BKCommonLib? Feel free to use the banner on your download page.
[[http://dev.bukkit.org/bukkit-plugins/bkcommonlib/|{{http://ci.dj-tcraft.nl/job/BKCommonLib/lastSuccessfulBuild/artifact/target/BKCommonLibVersion.png|Go to the BKCommonLib Dev-bukkit page}}]]
@mammuthuslol
lool mam if you read the http://forums.bukkit.org/threads/safeguarding-against-unchecked-and-potentially-damaging-plugins.116749/page-7#post-1461651
you would see that berger is not selfish just got his hands tied even if he updated it would not be approved by bukkit bukkit tied his hands not the other way around and lets see you use his plug ins do you donate to him or are you just a user god i hate uneducated people
Ha-ha.
You are truely the selfish one to think that someone is required to coninue to work on this for you.
Yep. And experience shows me that this is so.
Secondly, good developer must provide to another dev his project.
But here dev said to us: fuckoff.
Maybe, u havn't got a lot of experience with developers, so can't understand wut i'm talking about and don't know about standart practice of changing devs. In any case, I wont talk with you here.
P.S.
Autor is selfish asshole
@mammuthuslol
You are such a joke. You are truely the selfish one to think that someone is required to coninue to work on this for you. Someone will eventually pick it up and update it. You are pathetic.
Thank you bergerkiller for a good product while it lasted. I only hope someone picks it up soon to update it.
Autor is selfish asshole
PLEASE UPDATE!!! Most of my plugins explode into errors in the latest build because this plugin is broken...
Well this is a shame. Multiverse is crap.
With version #2546 1.4.6-R0.1: http://dl.bukkit.org/downloads/craftbukkit/view/01712_1.4.6-R0.1/
BKCommonLib 1.39 #17 don't work. Here is the error returned:
Can you do an update please?
Crap.
Broken in 1.4.5-R1.0
Wtf? Latest BKCommonLib can't work with 1.4.5-R1.0?
@lord0o 1.39 is only for the latest development build of R0.3.
PLEASE HELP!!!! I'm using 1.39 :S:S:S
@Puremin0rez Next version will be compatible.
Where to place it ? Bukkit console says "Could not load 'plugins\BKCommonLib.jar' in folder 'plugins'" Can you help me ?
Does the package of your latest development builds work with the new NMS changes?
@hawkfalcon It's there, but there is no javadoc online page yet. All if not most methods in there have proper javadocs, I just didn't manage to put them online (separate) somewhere. I did mavenize BKCommonLib, so that should make it easier to see the javadocs. (you can pull the project locally and see the javadocs that way)
Is there a chance of a javadoc being made for this?:)
@Jamesst20 Not too long, unless certain people *cough* start hindering the use of alternative class loaders to fix their dynamic package paths of course. Then I will have to start my own CraftBukkit server branch that does what my plugin does through class loaders. There isn't much of a difference in logic anyhow.
@bergerkiller
Yeah I know, I've seen my own plugin broken too but I fixed them. How long should I expect to get MyWorlds + BKCommonLib fixed?
@Jamesst20 Don't expect an update anytime soon, their new changes will cause a flood of shit to hit the plugin developer's faces. Anyway, don't use the newest Spigot because it won't work with most of the plugins you use. I'm working on next version compatibility, of course, but making it compatible with the latest build makes it incompatible with the beta, 1.4.5 R0.2.