BKCommonLib

empty

BKCommonLib logo BKCommonLib will not be updated to 1.8 for some time, we are experiancing issues geting spinot working, it is necesarry for the development of BKCommonLib, if you are able to provide spigot without package versioning please contact lenis0012 in a PM

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

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/)

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}}]]

Development Builds

DevBukkit Disclaimer
Click here to Download development builds of this Plugin

Go to the BKCommonLib Dev-bukkit page

Click here to add this banner to your page
How to place useful comments How to install plugins Solving errors and when to report them Reading and writing YAML

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of carmeops carmeops Apr 24, 2015 at 22:47 UTC - 0 likes

    my server is running spigot-1.8.1-20150304a, i don't plan to downgrade (even to a patched 1.9.10-1.8) for the sake of one plugin, but we could upgrade to 1.8.3 for bkcommonlib

  • Avatar of PsychoLynx PsychoLynx Apr 24, 2015 at 19:45 UTC - 0 likes

    @bubba1234119: Go

    Their version of CB/Spigot or BKCommonlib? We're running Bukkit-1.7.9-R0.2-20-g0b2ed13-b3108jnks (MC: 1.7.10) for now, but we'll be upgrading to the latest Spigot 1.8.3 when th new BKCommonlib is available. For now we're running v 1.59.

  • Avatar of bubba1234119 bubba1234119 Apr 24, 2015 at 05:39 UTC - 0 likes

    Sorry for the delay guys, I am deeply sorry for dropping off in the middle of development. I hit a wall where things would just be too difficult to implement due to packet changes. However I have a plan to get it working in 1.8 but it will require a bit of work on my send. I will see what I can do.

    Edit: I am going to provide patches to update craftbukkit/spigot 1.7.10 to support 1.8 with the new features with using the old packet stuff. If people who are using bkcommonlib for anything tell me their version so I can target it.

    Last edited Apr 24, 2015 by bubba1234119

    BFAK:90642789,153ac177207f00ebddc5ba83645175fb1738b569259e848868e1cb639e0c9528

  • Avatar of carmeops carmeops Apr 23, 2015 at 14:55 UTC - 0 likes

    oh my bad, didn't see that they changed it from "no official update until sponge" to "wait a bit, we got issues with spigot"

    that does change perspective... a bit more communication would be appreciated from them then

  • Avatar of aberts10 aberts10 Apr 23, 2015 at 03:33 UTC - 0 likes

    @KamikazePlatypus: Go

    I agree... I hate that they Change it up from abandoned to "Fixing issues with 1.8" and then leave you with no status for months, and maybe even eventually year(s), id rather they say, "Status update: We are close to a finish, Such and such events need to be updated now."

    Last edited Apr 23, 2015 by aberts10

    http://s21.postimg.org/ggx3hwa9f/Aberts10.png

  • Avatar of KamikazePlatypus KamikazePlatypus Apr 23, 2015 at 00:18 UTC - 0 likes

    @carmeops: Go

    I never said they had any obligation to update it. All I'm saying is rather than just leave people in suspense, waiting for an update, they should either abandon it or find someone new to maintain it. It's better to have some closure and say "Hey, I don't intend on updating this anymore" rather than just leave it. Sure they don't have to, but it's a courtesy to the users.

  • Avatar of carmeops carmeops Apr 22, 2015 at 23:39 UTC - 0 likes

    @KamikazePlatypus: Go

    i'm just saying that the authors don't have any obligations to continue to update the plugin, they aren't paid for it, they do it for free, it's open licence, so or you update it yourself, or just wait and be glad if someone do work on it

  • Avatar of KamikazePlatypus KamikazePlatypus Apr 22, 2015 at 15:48 UTC - 0 likes

    @carmeops: Go

    Just because it's open source doesn't mean it should just be left to die. And I'm doubtful that there will be a Sponge update given the unprofessionalism of this whole fiasco.

  • Avatar of carmeops carmeops Apr 22, 2015 at 06:33 UTC - 0 likes

    @KamikazePlatypus: Go the library isn't just for traincarts, but most people use it for that

    it's an open licence plugin, anyone can work on it if they want, the authors already stated that they are waiting sponge to continue it, so don't hope from them for 1.8

    i had my hopes in Bouba, but seem like my server will have to do without traincarts until sponge is released

  • Avatar of KamikazePlatypus KamikazePlatypus Apr 22, 2015 at 03:38 UTC - 0 likes

    This is getting pretty ridiculous. I've never seen a developer who's so inactive... and such a convoluted library for a minecart plugin. If the developer can't update the plugin and is relying on other people, then the manager/maintainer of the plugin should either find a new developer or abandon the plugin.

Facts

Date created
Sep 18, 2012
Category
Last update
Oct 27, 2014
Development stage
Release
Language
  • enUS
License
GNU General Public License version 3 (GPLv3)
Curse link
BKCommonLib
Downloads
985,081
Recent files
  • R: v1.59 (1.7.10) for CB 1.7.9-R0.2 Oct 27, 2014
  • R: v1.58 for CB 1.7.9-R0.1 May 21, 2014
  • R: v1.57 for CB 1.7.2-R0.2 Jan 26, 2014
  • R: v1.56 for CB 1.6.4-R2.0 Nov 17, 2013
  • R: v1.55 for 1.6.4 Sep 30, 2013

Authors