SignalsLib

SignalsLib

SignalsLib is a small library plugin for writing event-driven Minecraft plugins with a simple signal API backed by GEB. It comes in one jar per platform:

Usage

Install the jar for your platform in the server or proxy plugins/ folder (only one of the Bukkit and Folia jars, they share the plugin name SignalsLib), then add this to your plugin:

depend: [SignalsLib]

BukkitSignals.shared()
    .players().join()
    .connect(event -> event.getPlayer().sendMessage("Hello!"));

Fluent event options are available:

BukkitSignals.shared()
    .players().interact()
    .high()
    .ignoreCancelled()
    .connect(event -> event.getPlayer().sendMessage("Interacted"));

For Developers

repositories {
    maven { url = 'https://packages.tamkungz.me/maven/' }
}

dependencies {
    compileOnly 'me.tamkungz:signals-bukkit:0.2.3-SNAPSHOT'
    // signals-folia, signals-bungeecord and signals-velocity for the other platforms
}

For Folia, Velocity and BungeeCord/Waterfall usage, see the README.

Requirements

• Minecraft: 1.16.5 through 26.x (Spigot and Paper)
• Bukkit/Spigot API baseline: 1.16.5
• Folia jar: Folia or Paper 1.20 or newer
• Proxy jars: BungeeCord, Waterfall or Velocity 3.x
• JVM: Java 17 or newer

Credits

Built on GEB - Generative Event Bus by zaaarf.

• https://zaaarf.foo/projects/geb/
• https://github.com/zaaarf/geb

SignalsLib is licensed under the WTFPL. Bundled GEB is MIT licensed (see META-INF/third-party/geb-LICENSE.txt).