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}}]]
It's been a while since I checked out my train carts world as it didn't previously work with Cauldron. Seeing today that bkcommonlib has been released including support for Cauldron I thought I would give it another go.
The good news is that both BKCommonLib and TrainCarts enable ok. However BKCommonLib throws the following during the initialization:
as well as...
Trying to spawn a cart I get:
[13:55:56 ERROR]: [Train_Carts] Failed to execute REDSTONE_ON for SignActionSpawn: java.lang.RuntimeException: Could not initialize Entity Class Builder for 'EntityMinecartEmpty': at com.bergerkiller.bukkit.common.reflection.ClassBuilder.<init>(ClassBuilder.java:123) [?:?]
If anyone wants the full logs I'm happy to provide them.
So did anyone manage to get any 1.7 version of cauldron/mcpc working with TrainCarts/BKCommonLib?
@lenis0012
Couldn't you just decompile the Spigot jar?
Guys the problem is that i cannot get s spigot build without versioning.
Spigot's DMCA has made it hard for me to find their source code and remove the versioing package,
Thats the only thing preventing me
@carmeops
Only he doesn't update it the "right" way... So it is not really a hypetrain...
a new fork on github appeared, getting so close, we can almost taste it #allaboardthehypetrain
@JacobHarbour
You can compile the version Sanjay has made here: https://github.com/sanjay900/BKCommonLib
@JacobHarbour
The 'old' developers removed the development-build page with all of the development builds on it. For the reason "Moving to sponge" but they didn't move to sponge at this point. Giezenberg is working on a full 1.8 version if i'm right. I have a old development version of BKCommonlib on bukkit 1.7.10 running. I can send that to you if you want it. Just send a PM to me.
Hello! I have noticed that the Development-Build page is not working. I have a server that is dependent on this plugin. Do you by chance have a download for a version that supports 1.7.10 Spigot (Allows 1.8 Clients) ? If you did that would be awesome. Thank You!
@giezenberg I fully support bryanF1001s comment. I tried migrating bkcommonlib myself and saw what kind of effort is necessary to make this 1.8 compatible. I'll give you any help and all the praise :)
@bryanF1001
Your welcome man. I just need it for myself and I would be a jurk if I keep it for myself.
@giezenberg
Great work Giesenberg, hope it will be finished soon. I and my entire crew are very grateful that you're updating this plugin. I sertainly appreciate the time and efford you have put into updating this.
@woeterman94
It takes time to update 350+ classes of pure NMS code and a hell lot of changed imports. Just wait a bit for me or someone else to finish it.
@TMCThomas
It is not online, because the plugins doesn't compile yet.
I love the "Reasons for you to depend on this library" section.
I'd love to rely on bkcommonlib, but it always takes ages before it is updated to the new minecraft version :/ Can you please make this plugin compatible with bukkit 1.8.1 ?
@giezenberg
Where can i find your build server?
@PhatMale
@Mephisto43
@andrewvpo
@zody0210
The test builds will be available on my build server, but I still need to finish it. In no other way you can start testing if it can't compile.
I also would be willing to test out the build of you want to message me and send me a download file for 1.8. I have a smaller following though my visitors are constantly asking to install the traincarts plugin so they can build larger coasters. The server available I'd be running it at is mc.phatmale.com then once connected type /plot1.8 in chat- gotta be in 1.8+ client.
@andrewvpo
I'd be gladly willing to give a test version a test drive as well. Much like your server, I have a large rail network as well which is made up of 10 different lines (7 Normal routes & 3 Express trains) on my server, so this means I either keep my rail system running in 1.7.10 or I have to shut it down in 1.8.
@andrewvpo
all the same here, as soon a test build is available, i'll test it on my network, represented by the lines on this map :)
exept it's not useless atm cause we stayed in 1.7.9 for it :p
@zody0210
Same here! Each coloured line on this map represents many hours of blood, sweat and tears... and it's all useless at the moment :P Happy to test & offer feedback.
@giezenberg I have a rather large TrainCarts Network on my server. I'll offer my help in testing as well.