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}}]]
Man, four months :(
@giezenberg
Ah I see. Still needs some more changes before it can compile though.
@KamikazePlatypus
The changes are in an other branch, don't know the name anymore...
@carmeops
There's no changes in Kpaulisse's fork as of yet.
@JK82NL
bubba1234119, KamikazePlatypus, giezenberg and others where working on it the past weeks, look the comments down here, bubba is busy atm but he was close to have a working version for 1.8
check here: https://github.com/bergerkiller/BKCommonLib/network and here: https://github.com/bergerhealer/BKCommonLib/network
Bergerkiller won't work on it until Sponge is out, but i still have my hope with the other guys :3
edit: i see Kpaulisse has done some work on it yesterday, yay!
Bergerkillers last login was Nov 01, 2014.
High probability this is dead, unless someone else picks it up.
Even the development page that is stated here doesn't exist anymore.
@KamikazePlatypus
but, Bubba, two weeks ago, said he could probably push a working build soon XD
let me believe man, i need to believe, i already made all the new railroad for our server on our 1.8 map, i want to believe XD
@djmentalvibe
Like I said, this place is a graveyard. I'm not sure BK will ever get updated at this rate...
@Burockk
use the v1.58 for spigot 1.7.9, the v1.59 is for 1.7.10
I cant use this with spigot 1543 (1.7.9-r0.3-snapshot) what can I do for it can you help me?
Hey I've been watching this thread for so long now and wanted to know if you have any idea at all when we will roughly be getting a update so i can plan what we will do on our server.
Thanks for your time
Reece
@bubba1234119
Are you planning on updating it to Spigot 1.8.3?
@PsychoLynx
It should work out of the box, but if it isn't compatible it should be fixed easily.
@thief001
yeah, ofcourse, but i got some players designed as engineer, they have the perms to create traincarts signs to help the staff, but we don't want them to have mcedit perms, so, for us traincarts is more useful
@bubba1234119
It would probably be too convenient, but will TrainCarts work out of the box with the updated BKCommonLib? If not, how long do you think it'll take to update TC?
<<reply 251252
true with the more complex crossing.
but on that point i cheat and use the downloadable crossing from bytecart and mcedit :D
@thief001
we use traincart for everyone's bases in our server, one main track going in all directions, people can hook to it, make stations with destinations of their choice and the pathfinding and no collision make sure everyone can go anywhere they want without having to do anything, except press one single button
with that, we can refuse to give tpa and portals to our players, they cannot get mad :3
just have to make sure no sign was forgotten, no rail is missing and have to do a /train reroute at each alteration of the circuit, but it work perfectly, can't wait to have it back :)
edit: i watched a bit your Bytecart, sound interesting, but way more complex to build than traincart: with traincart, to make a "router", it's simply two rail crossing with 4 sign of text under the crossing: done
yay, would be nice.
trains back on track, and wireless-redstone back working.. no need to rebuild all with an alternate redstone plugin :)
@carmeops:
did you use traincarts for routing selection? how does it work there? i use bytecart for cartrouting does a perfect job on multi-link lines :)
hype train is back then! \o/
we just updated to 1.8 on our server, a few days to build a new railroad, and possibly could line up with the return of traincart! can't wait :)
@bubba1234119
Hooray!