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:

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 NoHoPeLess NoHoPeLess Apr 15, 2014 at 03:59 UTC - 0 likes

    an update to 1.7.8 would be nice :D thx for all

    BalayaCraft! Server-IP 80.241.215.15:25573 | BalayaCraft-Website | Facebook | Twitter | Youtube |

  • Avatar of Samueljuhasz Samueljuhasz Apr 14, 2014 at 18:52 UTC - 0 likes

    Support 1.7.8 pls :D

    I need more players on my server!

    IP: citycraft.4minecraft.de

    The domain is german, but the server language is english!

  • Avatar of Simonsigge Simonsigge Apr 13, 2014 at 15:08 UTC - 1 like

    Please update. <3

  • Avatar of derSzia derSzia Apr 13, 2014 at 10:52 UTC - 0 likes

    @Sauronmordor756: Go

    Friendly please....He makes it voluntary and not for money...

  • Avatar of Sauronmordor756 Sauronmordor756 Apr 12, 2014 at 14:29 UTC - 0 likes

    Update it

  • Avatar of DavidSBB DavidSBB Apr 12, 2014 at 12:24 UTC - 1 like

    Doesn't work with 1.7.8 (spigot #1399)!

  • Avatar of lenis0012 lenis0012 Apr 11, 2014 at 06:00 UTC - 0 likes

    @WhyIsItReal: Go

    the last dev builds work with the latest spigot (1.7.7/1.7.5/1.7.2) But not the official 1.7.7 builds

    lenis0012.com (Comming soon)

  • Avatar of WhyIsItReal WhyIsItReal Apr 11, 2014 at 01:03 UTC - 0 likes

    Is this compatible with Spigot build #1383 and Minecraft 1.7.7?


    Want to thank me a different way? Click here!
  • Avatar of lenis0012 lenis0012 Apr 10, 2014 at 22:22 UTC - 0 likes

    @joannou1: Go

    @Swords761: Go

    1.7.2 -> 1.7.4 was a hard update.
    I got someone to help me this weekend tho.
    Chunkr

  • Avatar of Swords761 Swords761 Apr 10, 2014 at 16:17 UTC - 0 likes

    @lenis0012: Go

    No rush, take your time, your work is much appreciated! :) It's really not a big deal, I downgraded to 1.7.2- you're not required to do anything for anyone, but it's just good to know you're around and know about the issue.

    http://www.planetminecraft.com/files/banner/43849.png?t=1351465633

    BFAK:Swords761,90637806,85b51b10560927b784f060122f064bf346c13665b4d5b5e0d3e624fd91fb297f

Facts

Date created
Sep 18, 2012
Category
Last update
Jan 26, 2014
Development stage
Release
Language
  • enUS
License
GNU General Public License version 3 (GPLv3)
Curse link
BKCommonLib
Downloads
908,423
Recent files
  • 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
  • R: v1.54-REVISITED for CB 1.5.2-R1.0 Aug 16, 2013

Authors