https://github.com/lucko/helper
A collection of utilities and extended APIs to support the rapid and easy development of Bukkit plugins.
https://github.com/lucko/helper
bukkit bukkit-plugin spigot
Last synced: 8 days ago
JSON representation
A collection of utilities and extended APIs to support the rapid and easy development of Bukkit plugins.
- Host: GitHub
- URL: https://github.com/lucko/helper
- Owner: lucko
- License: mit
- Created: 2017-01-15T18:15:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T15:07:04.000Z (10 months ago)
- Last Synced: 2025-04-03T11:12:07.986Z (17 days ago)
- Topics: bukkit, bukkit-plugin, spigot
- Language: Java
- Homepage:
- Size: 1.95 MB
- Stars: 458
- Watchers: 13
- Forks: 89
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-minecraft - helper - A collection of utilities and extended APIs to support the rapid and easy development of Bukkit plugins. (Utilities)
- awesome-minecraft - helper - A collection of utilities and extended APIs to support the rapid and easy development of Bukkit plugins. (Utilities)
README
# helper [](https://ci.lucko.me/job/helper/) [](https://discord.gg/Rnbpc7s)
helper is a development toolkit / library for Bukkit plugin developers. It provides a number of utilities and extended APIs which help to reduce boilerplate code and offer alternative paradigms for creating content.
#### History
💡 helper started off as a library to experiment with an alternative paradigm for creating [event listeners](https://github.com/lucko/helper/wiki/helper:-Events). Over time, more functionality has been added, usually as a response to a specific development need as I completed freelance work.
🌍 I don't use helper in any of my public projects - it's quite a big library, and I don't like to add bloat unnecessarily!
✅ However, it has been used extensively in a number of private server projects, most notably, in most custom plugins on servers operated by [Voldex Games](https://voldex.net/) (TheArchon, PrimeMC, etc). I'm also aware of a number of other developers / development teams who still actively use helper, which is awesome!
#### Status
I'm no longer actively working on further API additions, but the project is still being used frequently by various development teams, and I accept pull requests!
### Links
* [**Download**](https://ci.lucko.me/job/helper/) (download links for the standalone helper plugins)
* [**Wiki**](https://github.com/lucko/helper/wiki/) (*almost-fully-complete* documentation for helper)
### Modules
##### [`helper`](https://github.com/lucko/helper/tree/master/helper): The main helper project
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper/target/helper.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper) [](https://javadoc.io/doc/me.lucko/helper)
##### [`helper-sql`](https://github.com/lucko/helper/tree/master/helper-sql): Provides SQL datasources using HikariCP.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-sql/target/helper-sql.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-sql) [](https://javadoc.io/doc/me.lucko/helper-sql)
##### [`helper-redis`](https://github.com/lucko/helper/tree/master/helper-redis): Provides Redis clients and implements the helper Messaging system using Jedis.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-redis/target/helper-redis.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-redis) [](https://javadoc.io/doc/me.lucko/helper-redis)
##### [`helper-mongo`](https://github.com/lucko/helper/tree/master/helper-mongo): Provides MongoDB datasources.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-mongo/target/helper-mongo.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-mongo) [](https://javadoc.io/doc/me.lucko/helper-mongo)
##### [`helper-lilypad`](https://github.com/lucko/helper/tree/master/helper-lilypad): Implements the helper Messaging system using LilyPad.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-lilypad/target/helper-lilypad.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-lilypad) [](https://javadoc.io/doc/me.lucko/helper-lilypad)
##### [`helper-profiles`](https://github.com/lucko/helper/tree/master/helper-profiles): Provides a cached lookup service for player profiles.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-profiles/target/helper-profiles.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-profiles) [](https://javadoc.io/doc/me.lucko/helper-profiles)
##### [`helper-js`](https://github.com/lucko/helper/tree/master/helper-js): JavaScript plugins using Nashorn.
[](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-js/target/helper-js.jar) [](https://maven-badges.herokuapp.com/maven-central/me.lucko/helper-js) [](https://javadoc.io/doc/me.lucko/helper-js)
## Feature Overview
* [`Events`](https://github.com/lucko/helper/wiki/helper:-Events) - functional event handling and flexible listener registration
* [`Scheduler`](https://github.com/lucko/helper/wiki/helper:-Scheduler) - easy access to the Bukkit scheduler
* [`Promise`](https://github.com/lucko/helper/wiki/helper:-Promise) - a chain of operations (Futures) executing between both sync and async threads
* [`Metadata`](https://github.com/lucko/helper/wiki/helper:-Metadata) - metadata with generic types, automatically expiring values and more
* [`Messenger`](https://github.com/lucko/helper/wiki/helper:-Messenger) - message channel abstraction
* [`Commands`](https://github.com/lucko/helper/wiki/helper:-Commands) - create commands using the builder pattern
* [`Scoreboard`](https://github.com/lucko/helper/wiki/helper:-Scoreboard) - asynchronous scoreboard using ProtocolLib
* [`GUI`](https://github.com/lucko/helper/wiki/helper:-GUI) - lightweight by highly adaptable and flexible menu abstraction
* [`Menu Scheming`](https://github.com/lucko/helper/wiki/helper:-Menu-Scheming) - easily design menu layouts without having to worry about slot ids
* [`Random`](https://github.com/lucko/helper/wiki/helper:-Random) - make random selections from collections of weighted elements
* [`Bucket`](https://github.com/lucko/helper/wiki/helper:-Bucket) - sets of distributed and uniformly partitioned elements
* [`Profiles`](https://github.com/lucko/helper/wiki/helper:-Profiles) - a lookup repository and cache for player uuid & name profiles
* [`Plugin Annotations`](https://github.com/lucko/helper/wiki/helper:-Plugin-Annotations) - automatically create plugin.yml files for your projects using annotations
* [`Maven Annotations`](https://github.com/lucko/helper/wiki/helper:-Maven-Annotations) - download & install maven dependencies at runtime
* [`Terminables`](https://github.com/lucko/helper/wiki/helper:-Terminables) - a family of interfaces to help easily manipulate objects which can be unregistered, stopped, or gracefully halted
* [`Serialization`](https://github.com/lucko/helper/wiki/helper:-Serialization) - immutable and GSON compatible alternatives for common Bukkit objects
* [`Bungee Messaging`](https://github.com/lucko/helper/wiki/helper:-Bungee-Messaging) - wrapper for BungeeCord's plugin messaging API
* [`JavaScript Plugins`](https://github.com/lucko/helper/wiki/helper-js:-Introduction) - javascript plugins using helper-js and Nashorn
[`... and much more!`](https://github.com/lucko/helper/wiki/)