SignalsLib
SignalsLib 是一个小型库插件,用于使用基于 GEB 的简单信号 API 编写事件驱动的 Minecraft 插件。每个平台对应一个 jar 包:
| 平台 | Jar 包 |
|---|---|
| Bukkit, Spigot, Paper | SignalsLib-Bukkit-*.jar |
| Folia | SignalsLib-Folia-*.jar |
| BungeeCord, Waterfall | SignalsLib-BungeeCord-*.jar |
| Velocity | SignalsLib-Velocity-*.jar |
使用方法
将对应平台的 jar 包安装到服务器或代理服务器的 plugins/ 文件夹中(Bukkit 和 Folia 的 jar 包只需安装其中一个,它们共享插件名称 SignalsLib),然后在你的插件中添加以下内容:
depend: [SignalsLib]
BukkitSignals.shared()
.players().join()
.connect(event -> event.getPlayer().sendMessage("Hello!"));
支持流畅的事件选项配置:
BukkitSignals.shared()
.players().interact()
.high()
.ignoreCancelled()
.connect(event -> event.getPlayer().sendMessage("Interacted"));
开发者指南
repositories {
maven { url = 'https://packages.tamkungz.me/maven/' }
}
dependencies {
compileOnly 'me.tamkungz:signals-bukkit:0.2.4-SNAPSHOT'
// signals-folia, signals-bungeecord and signals-velocity for the other platforms
}
有关 Folia、Velocity 以及 BungeeCord/Waterfall 的使用说明,请参阅 README。
要求
- Minecraft: 1.16.5 至 26.x(Spigot 和 Paper)
- Bukkit/Spigot API 基线版本:1.16.5
- Folia jar 包:Folia 或 Paper 1.20 或更高版本
- 代理服务器 jar 包:BungeeCord、Waterfall 或 Velocity 3.x
- JVM:Java 17 或更高版本
致谢
SignalsLib 基于 zaaarf 开发的 GEB - Generative Event Bus 构建。
SignalsLib 采用 WTFPL 许可证授权。捆绑的 GEB 组件采用 MIT 许可证授权(详见 META-INF/third-party/geb-LICENSE.txt)。
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:
| Platform | Jar |
|---|---|
| Bukkit, Spigot, Paper | SignalsLib-Bukkit-*.jar |
| Folia | SignalsLib-Folia-*.jar |
| BungeeCord, Waterfall | SignalsLib-BungeeCord-*.jar |
| Velocity | SignalsLib-Velocity-*.jar |
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.4-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.
SignalsLib is licensed under the WTFPL. Bundled GEB is MIT licensed (see META-INF/third-party/geb-LICENSE.txt).
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
下载 SignalsLib
需要联机服务器吗?
稳定流畅、一键部署,几分钟即可和朋友联机开服
最低仅需 8 元/月 即可畅快联机
0.2.4-SNAPSHOT
修复了在 BungeeCord 和 Velocity 上,当仅存在监听器位于子总线(sub-bus)时事件被丢弃的问题,并添加了 Signal.next、Signal.connectOn、支持返回连接的调度器注册以及 BukkitSignals.mainThread()。无破坏性变更。
已修复
signals-bungeecord、signals-velocity:当信号的listenerCount()为 0 时,桥接器会跳过某个事件。因此,仅存在于子总线上的监听器(如 README 中所述的geb().subBus(...))虽然能在 Bukkit 上接收到事件,但此前却从未收到该事件。现在它们会调用hasReceivers,该方法会对子总线进行计数。signals-bukkit:信号的 Bukkit 处理器会永久保持注册状态,并且即使没有连接任何监听器,也会为每个事件构建并分发值(例如每一个PlayerMoveEvent)。现在它会像另外两个桥接器一样,跳过无法被接收的事件。- Javadoc:
GebBridge.registerDispatcher现在说明一个总线针对每种事件类型保留一个调度器,新的调度器会替换旧的;unregisterDispatcher说明仅移除相同实例。SignalBus.fire现在说明 GEB 不会捕获监听器的异常,因此异常会传递至调用方。SignalBus(IBus)现在说明共享同一个 GEB 总线的总线能看到彼此的值。以上三点均已对照 GEB 0.5.4 版本进行核实。
新增
Signal.next()和Signal.next(Predicate):一个CompletableFuture,将在获取下一个(匹配的)值时完成。当 future 完成或被取消时,监听器将断开连接;抛出异常的谓词会导致 future 失败,而不是让异常传播到触发事件的代码中。Signal.connectOn(Executor, Consumer)及其ConnectionGroup变体:在指定的执行器上运行监听器,以切换到其他线程。如果在连接断开前已排队的任务将被跳过。SignalBus.hasReceivers(Class)、SignalBus.hasReceivers(SignalKey)和Signal.hasReceivers():用于判断触发事件是否能到达监听器,包含对子总线的计数。由GebBridge.hasSubBuses()提供支持。GebBridge.dispatcher(IEventDispatcher)和GebBridge.loadDispatchers(ClassLoader),各自带有ConnectionGroup变体:用于注册调度器并获取一个用于注销它们的Connection。在共享总线上,通过registerDispatcher或loadAndRegisterDispatchers注册的调度器在注册它们的插件重载后仍会保留。loadDispatchers是“全有或全无”的机制:如果服务文件损坏,则会注销已加载的内容。signals-bukkit:BukkitSignals.mainThread(),一个用于服务器主线程的Executor,可与connectOn配合使用,以处理非主线线程的事件(例如players().chat())。不适用于 Folia。- 24 个新的
signals-core测试(总计 72 个,原为 48 个):涵盖fire、hasReceivers(包括针对子总线 bug 的回归测试)、next(值、谓词、取消、失败的谓词、并发触发)、connectOn(顺序、跳过任务、内联、组、空值检查)、调度器连接(替换、保留被替换的调度器、回滚、组、空值检查)、子总线跟踪以及一个 GEB 总线上挂载两个总线等情况。
更改
GebBridge.loadAndRegisterDispatchers现在委托给loadDispatchers:行为相同,区别在于如果服务文件损坏,之前已读取的调度器不再保留。- README:更新了关于
next、connectOn、mainThread、调度器连接、关于在共享总线上使用clear()的警告以及子总线注意事项的内容。GEB Direct Use 示例现在会在onDisable中进行清理。 - 版本号现已更新为
0.2.4-SNAPSHOT。
关于这个资源的讨论、问题反馈与使用心得
还没有讨论,来发第一帖吧
你是这个资源的作者?登录后可认领此资源。
相似资源
插件
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
插件
ExyliaPlugins 的库。
插件
通过对话框或铁砧界面帮助你的 Anthme
插件
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
插件
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
插件
用于绘制游戏内地图或在浏览器中随探索实时进行地图绘制的实时地图。
评论 0
登录后参与评分
还没有评论,来抢沙发吧