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}}]]
@lenis0012
i shall test it with honor! BergerKiller's works must go on.
@bergerkiller
Thanks BK ... you have been very, very good to minecraft ;)
I pushed lenis0012 his changes to my GitHub to have a quick start here, the produced file can be found on the above jenkins build server. (see bottom of main page)
I got a working BKCommonLib for mc 1.4.6
just need to test some stuff
Help me testing, pre-dev build: https://dl.dropbox.com/u/67122021/BKCommonLib.jar (use at own risk, needs alot of testing)
No new is often good news, but I just want to say that with all the dung that's happening with 1.4.6, your work is still over-the-top awesome. The features you incorporate into my server via your plugins are essential, even more than the Essentials plugin itself. On a computer with little more than 512 Mb of ram, with less than 290 Mb free for the actual server, things like NoLagg have saved my arse countless times as I'm trying to figure out whether the issue is a new plugin, other players, or merely the old hardware I'm running on. It's also why I force-downgraded my clients back to 1.4.5 because of all the things that broke, just so that I /could/ maintain these plugins on the server.
@bergerkiller
Thank you bergerkiller, for adding Vault support. Take your time with the updating to 1.4.6, but not too much ;) We all love your plugins, and I loved how you tried to take your stand against BukkitDev on the changing of NES. I was the guy in the background saying out loud "Yeah, you tell them!". Again, thanks for your plugins, I love them all.
Currently working on a version for 1.4.6
Bkcommonlib doesnt work for 1.4.6 even the dev builds sadly Y_Y
@TheMinecraftFormat
Link is broken.
There is a new build of it here http://ci.herocraftonline.com/job/BKCommonLib/
@bergerkiller
bergerkiller, On behalf of the people on my server, and myself... I want to thank you for all the work you have put into your plugins thus far. We're incredibly sad to see you go, and wish that any of us understood the coding lingo better, to perhaps help on the projects... We're using BKCommonLib, and TrainCarts extensively, and hate to see them go... therefore, I've decided that instead of Killing the plugins that we've loved... I'm just not updating the blasted server! :) We have had tons of fun so far, and personally only a couple of us like the idea of Fireworks (sarcastic woohoo) vs hooking up a long traincart system, and rocking the roller coaster rides! :) I'm not trying to 'flatter' you back into development, that would be disrespectful of your rightful wishes. :) I just want to convey that you've helped enhance a great game, with your hard work! Thank you so very much! Until I can learn coding, or somebody else can step up to the plate and take over the projects... I wish you well. My Server wishes you well! Again Thank you. Ignore the ignoramus' that call you selfish *coughs mammuthuslol* If he/she had half of the balls, maybe they would attempt a shot at the project? I didn't think so. . . :) (I hate when people ignore past hard deeds for their own self gain) Personal peeve aside......
Deepest Sympathies that you are going, but best of wishes! -TheLoneWolf85
One more update man ! ;o
He WONT update stop asking...
Please update :O
Please Update BkCommonLib To 1.4.6.
Please update to 1.4.6. Here is the ticket:
http://dev.bukkit.org/server-mods/nolagg/tickets/189-please-update-to-1-4-6/
Potential i mean.
@mammuthuslol
which one ?
gtfo :)
nope :)
bergerkiller is doing this because of the stupid decisions the Bukkit devs are making. End.
and the next dev of bklib will develop it w/o that problems. haha.
i hate uneducated people
Only u'r problems
@mammuthuslol
gtfo :)
bergerkiller is doing this because of the stupid decisions the Bukkit devs are making. End.