Home - lucko/helper GitHub Wiki

⚠️ Note: some wiki pages have not yet been written. I'd like to complete them all, but haven't found the time/motivation to do so just yet. Of course, this is a wiki, so you could contribute/edit the pages too! ⚠️

In the meantime, there are Javadocs and the source code which you can read.

💬 Use Discord to ask questions. 💬

Navigation

General

helper

Core functionality

  • Events - functional event handling and flexible listener registration
  • Scheduler - easy access to the Bukkit scheduler
  • Promise - a chain of operations (Futures) executing between both sync and async threads
  • Metadata - metadata with generic types, automatically expiring values and more
  • Commands - create commands using the builder pattern
  • Terminables - a family of interfaces to help easily manipulate objects which can be unregistered, stopped, or gracefully halted
  • Messenger - message channel abstraction
    • Channels - type-mapped system for sending Java objects between channel instances
    • Conversation Channels - channels which send messages requiring a reply from the recipient server
  • Extended Plugin - an extended plugin class for easy integration with the Terminable pattern and other useful tools
  • Serialization - immutable and GSON compatible alternatives for common Bukkit objects
  • Item - useful classes for working with ItemStacks
  • Menu - lightweight and highly adaptable menu abstractions
    • Gui - easy to use class for creating menus using a chest interface
    • Paginated Gui - automatic pagination of menu items
    • Menu Scheming - easily design menu layouts without having to worry about slot ids

Services

  • Scoreboard - extended scoreboard api with asynchronous implementation using ProtocolLib
  • Bossbar - fluent boss bar utility
  • Hologram - easily create and manage floating text displays backed by armor stands
  • Sign Prompt - receive input from players via sign prompts
  • BungeeCord - callback based API for BungeeCord's plugin messaging specification
  • Profiles - a lookup repository and cache for player uuid & name profiles
  • Npc - simplified API for managing static player NPCs with click callbacks

Utilities

  • Random - make random selections from collections of weighted elements
  • Bucket - sets of distributed and uniformly partitioned elements
  • Cache - useful cache classes
  • Config - simplified API for interacting with 'configurate' configs
  • Cooldown - simple utility for managing "timeouts" or defined waiting periods
  • Predicates - a number of useful Predicate implementations
  • Numbers - utilities to aid with the parsing of various types of number
  • Gson - provides a shared Gson instance, as well as a number of extra TypeAdapters for serialising Bukkit objects using Gson
  • Reflect - reflection made easy
  • Text - Utilities for working with Text Components and formatted text strings.

helper-sql

  • helper-sql plugin
  • SqlProvider
  • Sql

helper-redis

  • helper-redis plugin
  • RedisProvider
  • Redis

helper-mongo

  • helper-mongo plugin
  • MongoProvider
  • Mongo

helper-lilypad

  • LilyPad
  • LilyPadNetwork
  • RedirectSystem

helper-js