BKCommonLib 1.13.1-v4

Common utility library adding unique new features and API's

  1. TeamBergerhealer
    Tested Minecraft Versions:
    • 1.8
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    • 1.13
    Source Code:
    https://github.com/bergerhealer/BKCommonLib
    Contributors:
    bergerkiller, Friwi, mg_1999 (lenis0012 timstans bubba1234119)
    BKCommonLib_logo.png

    Welcome to BKCommonLib for Minecraft 1.8.8+. You can report bugs to me in the discussion Thread. Please use the format I provided there. Thank you!


    Since April 16, 2017 release version names will be in a MCVersion-pluginversion format. Released versions support older Minecraft versions, too!

    Supported server versions (tested):
    • CraftBukkit & Spigot 1.8.8, 1.9, 1.9.2, 1.9.4, 1.10.2
    • CraftBukkit 1.11.2 & Spigot 1.11.2 & Paperspigot 1.11.2
    • CraftBukkit & Spigot 1.12 (also 1.12-pre5 and 1.12-pre6)
    • CraftBukkit & Spigot 1.12.1, 1.12.2
    I am working on support for Minecraft 1.13. Expect it to take a while, the changes to the internals are massive.

    Newer in-development builds are available on our Jenkins CI server:
    https://ci.mg-dev.eu/job/BKCommonLib/


    Alternative builds available (old!):
    1.70 for MC1.9.0 (v1_9_R1)
    1.57 for MC1.8.6-1.8.9 (v1_8_R3)


    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 Spigot, it is added in BKCommonLib. This is one of the reasons why it has become this large: there are simply a lot of things Spigot 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. If you develop a plugin that uses BKCommonLib, make sure you depend on the earliest version that still offers the features you need. This makes sure your plugin remains functional on older Spigot builds.

    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 you 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 Spigot 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 Spigot 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
    • You want to toy with unique new APIs
    Features
    • General
    • 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 filtering, type conversion, and transformation
      • Utilities for retrieving all the players, entities, or block states in a chunk or on a world efficiently
      • Utilities for accessing world and chunk block data efficiently, bypassing physics and batch processing
    • Data storage
    • Entities
    • Services
      • 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 (support for Tab View will be readded soon)
      • MapDisplay services to display interactive and dynamic image contents on Minecraft maps
    Getting started
    To start using BKCommonLib, you have to include the jar file as a dependency (after adding BKCommonLib as dependency in the plugin.yml):

    Like any dependency, keep the jar file somewhere on your computer and add it to your classpath. Nothing special here.

    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:
    1. TC ActionBlocks
    2. TC Hangrail
    3. MinecraftTrainSimulator
    Disclaimer
    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.

    Credits
    @bergerkiller resumed development under the banner of TeamBergerhealer since March, 2017. This plugin has been in development for many years:
    1. Credits go to @bergerkiller, lenis0012 and timstans for developing the original version of this plugin until version 1.57
    2. Credits go to @mg_1999 and @KamikazePlatypus for their MC 1.8 fork of this plugin, including packet system changes
    3. Credits go to @Friwi for updating and maintaining the plugin for MC 1.8 and 1.9 until late december 2016

    Donate
    If you really like my work and want to give something in return, feel free to donate something small to me using the link down below. Thank you! :)

    [​IMG]
    smeths, ScarabCoder, inkdrak and 3 others like this.

Recent Reviews

  1. Joiubaxas
    Joiubaxas
    5/5,
    Version: 1.13.1-v4
    Greatest map management API ever! I don't know what I would have done without this library. Map color conversion method is about 200+ times faster than the bukkit method.
  2. PatrickBronke
    PatrickBronke
    5/5,
    Version: 1.13.1-v4
    Really good plugin! When will the update for 1.13.2 come?
    I need it for TrainCarts.
    1. TeamBergerhealer
      Author's Response
      Theres a dev build out since yesterday, it's still in the process of being tested
  3. iNiperx
    iNiperx
    5/5,
    Version: 1.13.1-v4
    This allows me to use the Light-Cleaner plugin which saves a lot of OCD frustration for me and I dont see performance impact on the server, can't wait for this to work on 1.13.2 (waiting for an update)
  4. MothMuse
    MothMuse
    5/5,
    Version: 1.12.2-v4
  5. bbayu
    bbayu
    5/5,
    Version: 1.12.2-v4
    This is an amazing plugin. With this plugin, I was able to create something that I originally thought was impossible in Minecraft! Keep up the good work!
  6. GameFreakBaree
    GameFreakBaree
    5/5,
    Version: 1.12.2-v3
    I don't find bugs and it is a fantastic plugin, but update it once more. The last update was: Oct 14, 2017.
    1. TeamBergerhealer
      Author's Response
      There are development builds available, but I can't push until all I've added in is stable, tested and the plugins using it don't need anything more. A new release will happen once TrainCarts is also ready for an update :)
  7. R00t
    R00t
    5/5,
    Version: 1.12.2-v2
    1st, awesome plugin, I want to know why it is so good, but Idk, because I’m mentally high atm.
  8. Kachu4271
    Kachu4271
    5/5,
    Version: 1.11.2-v2-reup
    bugfix good~! thanks alot! very very very very very very very very very very very very very very very good work!!!!!!!!!!!!!!!!!!!
  9. tychoblankvoort
    tychoblankvoort
    1/5,
    Version: 1.11.2-v1
    i have errors plz help me [email protected]!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  10. lucky_michael
    lucky_michael
    1/5,
    Version: 1.11.2-v1
    it does not work SO mutch errors!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!