BKCommonLib

empty

BKCommonLib logo

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 JimiRebeld JimiRebeld Sep 27, 2014 at 11:26 UTC - 0 likes

    1.8 Plase please

  • Avatar of cherbert cherbert Sep 25, 2014 at 08:24 UTC - 0 likes

    Its a lot of devs lately seem to have given up. This is an exceptional plugin - please please can we have it fixed for Cauldron 1.7.10 so I can run Traincarts again.

    Last edited Sep 25, 2014 by cherbert
  • Avatar of xmybu xmybu Sep 20, 2014 at 17:21 UTC - 0 likes

    @lenis0012: Go

    An update that works with the last Cauldron release would be good too - see issue #26. Otherwise guess I'm going to have to wait even longer for Sponge or give up :(

  • Avatar of lenis0012 lenis0012 Sep 19, 2014 at 05:52 UTC - 1 like

    @moqmar: Go

    Ill update it to1.7.10
    And that will be the last update

    I quit bukkit, Thanks everyone for alll your support throughout the years Good bye

  • Avatar of sanjay900 sanjay900 Sep 17, 2014 at 01:04 UTC - 0 likes

    I made a pull request. For those with the protocol hack it SHOULD work i think. I havent tested it with train carts, it works for portalstick though.

  • Avatar of moqmar moqmar Sep 14, 2014 at 10:21 UTC - 0 likes

    Yeah, please update the whole thing to Spigot 1.7.10 - I can't start the server with BKCommonLib - the error (with BKCommonLib as the only plugin) is http://pastebin.com/5Bp4TKCa

    If i add TrainCarts, I get "[Train_Carts] Failed to synchronize a network controller" 1000 times and more.

    And another question: Will you port your plugins to Sponge when it comes out? ;)

  • Avatar of xmybu xmybu Sep 10, 2014 at 09:05 UTC - 0 likes

    I hope I'm wrong but given all that's going on at the moment, what with the likely demise of Bukkit, the apparent lack of interest and the possibility of M$ buying Mojang, I'm wondering if this plugin will ever get updated again. I really enjoyed running trains around my minecraft world too thanks to TrainCarts and BKCommonLib.

  • Avatar of jacklollz2 jacklollz2 Sep 09, 2014 at 08:10 UTC - 0 likes

    @lenis0012: Go

    I didn't think it would be important to post that. Don't overlook that bug just because I didn't add it there. It's still persisting for me even on the latest build of both bukkit and the plugin. (But the plugin didn't update.) I really wish this would be updated by now, I don't understand what would be taking so long. 1.8 is going to be released soon, come on guys.

    Last edited Sep 09, 2014 by jacklollz2

    Hi I'm a Signature.

  • Avatar of Swords761 Swords761 Sep 08, 2014 at 05:59 UTC - 0 likes

    All of you need to calm down and patiently wait for an update... especially after this whole Bukkit "dying" debacle. Who knows if it's even worth continuing development of this plugin until the whole situation of Bukkit and nextsteps is figured out. But even if development of this plugin continues, show some respect and gratitude for lennis, because updating this sort of library plugin is no easy feat.

    http://static.planetminecraft.com/files/banner/43849_2.png

    BFAK:Swords761,90637806,85b51b10560927b784f060122f064bf346c13665b4d5b5e0d3e624fd91fb297f

  • Avatar of fsedarkalex fsedarkalex Sep 06, 2014 at 19:46 UTC - 0 likes

    Hi

    I tried it with your spinot variant... its definitely 1.7.10

    The result is the plugin loads but Myworlds causes it to malfunction or the other way round. just see the log. its about inventories...

    http://pastebin.com/WxGCWgby

Facts

Date created
Sep 18, 2012
Category
Last update
May 21, 2014
Development stage
Release
Language
  • enUS
License
GNU General Public License version 3 (GPLv3)
Curse link
BKCommonLib
Downloads
952,421
Recent files
  • 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
  • R: v1.54 for CB 1.6.2-R0.1 Aug 18, 2013

Authors