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}}]]
@Adrenalineq Depends on what you want to achieve, Spigot doesn't contain everything mind you. It mainly extends CraftBukkit to replace various collections with trove versions and optimizes server tasks like block physics. I don't think it contains a proper chunk sending system like in NoLagg, and I doubt even more that it contains something against TNT lag.
Also, this is a bit off-topic, we are on BKCommonLib here...
@Bo1998 This looks like either a change in CraftBukkit's latest dev build or Spigot itself. I'll see what I can do to keep compatibility with both. Also, if you didn't update to the latest BKCommonLib already, do so.
@Psychokiller1888 I think you have to update CraftBukkit OR BKCommonLib, either of the two. No such errors when I run on 0.2 so it must be related to your install.
@Bo1998
Spigot dont need nolagg...
This doesn't seem to work with Spigot.
http://pastie.org/5352826
Hey dude, again something is messed up, since last update you released on train carts
http://pastebin.com/8zh22xQc
Are your plugins made for 1.4.2 r02? I mean, shall we use the beta build??
v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM. CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9 08:44:54 PM CONSOLE: [SEVERE] Could not pass event EntityRemoveEvent to NoLagg v1.88.9
Where is the 1.34 version?
There's only 1.33 to download.
@toffose I'm pretty sure you are not using CraftBukkit 1.4.2 R0.1 or R0.2 then, as the field didn't change name. Or are you using a development build of some kind? Anyhow, couldn't reproduce.
I get the following while loading BKCommonLib, Version v1.33, Bukkit 1.4.2
@Toxic__Waste
Sorry, the way you put it... "I need it for my worlds" came off as "I need my worlds working so fix it."
Here's the correct Link:
http://dev.bukkit.org/server-mods/bkcommonlib/files/12-v1-33/
@bergerkiller
There does not seem to be a file available.
@CGLegends Keepin' it bumped:
http:dev.bukkit.org/server-mods/bkcommonlib/files/12-v1-33/
And update TrainCarts/NoLagg/MyWorlds/SignLink/Redstone Mania/Whathaveyou too, there are changes in all of them.
There is an error when trying to use nolagg and this together:
Please update, getting memory issues
@bergerkiller
Ah, I didnt see the download for TrainCarts yet. They both need to be installed correctly so bkcommonlib doesnt crashes I gues?
@bergerkiller
I meant like for example bukkit has a jd.bukkit.org/api-docs? Something like that...
Also is there a page i remember seeing it a while back but i lost it..
It told how to use the library properly..
Such as using the pluginbase.java file into your projects so if they don't have the required BK lib on. It would still load without classdef errors and such.. I don't know. I am a little messed up today can't think clearly. Sick xD... Love the library just never had time to use it much.
EDIT: Idiot moment. Maybe just do in plugin.yml dependency required on it :P sorry
@cannonb4ll TrainCarts also has updated. Please wait a bit longer, I finished updating MyWorlds and SignLink, I am now at Redstone Mania. I do in decreasing complexity so I get a better overview.
Getting some severe errors, and server completely crashes.
Build: 2420
BKCommonlib 1.33
Crash report:
http://pastebin.com/Y8EZnG0i
@coaster4321 BKCommonLib is full of them, but you may have to configure your IDE to use them properly. You can download the source from GitHub if you have to use it. (not sure HOW you get to display them either :/)
1.4 version is up:
http:dev.bukkit.org/server-mods/bkcommonlib/files/12-v1-33/
Any javadocs to the plugin. I really rely on those on libraries. My ide has special shit with them :D