HamsterAPI

插件

· 作者 LinsaFTW

轻量级 Spigot/Bukkit API 库,为开发者提供实用方法、性能导向的抽象层和共享系统,以加速插件开发。

0 本站下载 0 关注 更新于 1 个月前

最新 0.3.7 · 26.3 · Bukkit / Folia

一键开服(送7天)

HamsterAPI logo

HamsterAPI:你的终极 Minecraft 数据包操作工具包

无需触碰 NMS 或反射,即可轻松拦截、修改和发送数据包。


什么是 HamsterAPI?

HamsterAPI 是一个功能强大、高性能的库,旨在让开发者完全掌控 Minecraft 的网络协议。它提供了一个清晰的事件驱动抽象层,使您能够轻松且稳定地操纵跨多个服务器版本的传入和传出数据包。

忘掉维护复杂 NMS 代码的麻烦吧。使用 HamsterAPI,您将得到一个简单、优雅且面向未来的解决方案,适用于从创建自定义外观到在数据包层面修补漏洞的所有需求。

主要特性

  • ? 强大的数据包拦截: 通过灵活且基于优先级的系统,监听、修改和取消任何数据包。
  • ? 无 NMS 数据包发送: 毫不费力地向玩家发送标题(Titles)、动作栏(ActionBars)和其他数据包,无需担心反射或特定版本代码的问题。
  • ?️ 高级玩家控制: 安全地断开玩家连接并显示自定义消息,或直接关闭其连接通道。
  • ? 无缝 BungeeCord 集成: 轻松在服务器之间切换玩家,使用插件消息通道并管理您的网络。
  • ?️ 优化后的实用工具: 访问我们精简的反射和字节缓冲区实用工具,构建高级且与版本无关的功能。

快速开始

步骤 1:将 HamsterAPI 添加为依赖项

首先,确保在插件的 plugin.yml 文件中将 HamsterAPI 包含为依赖项。这是确保您的插件正确加载的关键步骤。

name: YourPlugin
version: 1.0
main: com.yourdomain.yourplugin.Main
depend: [HamsterAPI]
步骤 2:获取 API 实例

HamsterAPI 所有功能的入口点是单例实例。您可以在代码中的任何位置通过静态调用获取它:

HamsterAPI api = HamsterAPI.getInstance();

通过此实例,您可以访问所有核心管理器和实用工具:

  • getHamsterPlayerManager() - 管理针对玩家的操作,如发送数据包或断开连接。
  • getBungeeMessenger() - 与您的 BungeeCord 代理进行通信。
  • getPacketInjector() - 手动向玩家的网络管道注入或移除 API。
  • getBufferIO() - 用于将原始字节缓冲区解码为可读数据包的实用工具。

核心概念与使用示例

如何监听数据包

HamsterAPI 提供了强大的事件系统,用于在网络管道的不同阶段拦截数据包。

管道流程: 客户端 -> [分片器 & 解压缩] -> PacketDecodeEvent -> [解码器] -> PacketReceiveEvent -> 服务端

  • PacketDecodeEvent

    • 触发时机: 在原始字节被解压缩后,但在它们被解码为完整的数据包对象之前触发。
    • 获得内容: 一个原始的 ByteBuf 对象。
    • 适用场景: 底层安全防护、修复漏洞以及分析原始网络数据。
  • PacketReceiveEvent / PacketSendEvent

    • 触发时机: 在数据包已完全解码为 PacketWrapper 对象之后触发。
    • 获得内容: 用户友好的 PacketWrapper 对象。
    • 适用场景: 大多数常见用例,如创建自定义外观、取消游戏事件或修改游戏行为。

要监听事件,请像注册 Bukkit 事件一样注册一个监听器类。更多详情请参阅 Spigot Event API Guide。

示例:监听数据包

public class MyPacketListener implements Listener {

    @EventHandler
    public void onPacketSend(PacketSendEvent event) {
        // 获取数据包的名称
        String packetName = event.getPacket().getName();

        if (packetName.equals("PacketPlayOutChat")) {
            Player player = event.getPlayer();
            player.sendMessage("服务器试图向你发送一条聊天消息!");
            
            // 你甚至可以取消该数据包
            // event.setCancelled(true);
        }
    }
}
发送标题和副标题
// 获取特定玩家的 HamsterPlayer 实例
HamsterPlayer hamsterPlayer = HamsterAPI.getInstance().getHamsterPlayerManager().get(player);

// 发送一个标题,淡入时间为 1s,停留 3s,淡出时间为 1s。
// 时间单位为刻(20 刻 = 1 秒)
hamsterPlayer.sendTitle("§a欢迎!", "§7享受您的入住。", 20, 60, 20);
发送动作栏消息
HamsterPlayer hamsterPlayer = HamsterAPI.getInstance().getHamsterPlayerManager().get(player);

hamsterPlayer.sendActionbar("§e你有 §c5§e 条新消息。");
安全断开玩家连接(数据包踢出)

这将发送一个正式的连接断开数据包,允许客户端优雅地处理踢出操作并显示您的自定义原因。

HamsterPlayer hamsterPlayer = HamsterAPI.getInstance().getHamsterPlayerManager().get(player);

hamsterPlayer.disconnect("§c因为你太棒了,你已被踢出。");
立即关闭玩家连接

这将立即终止通道而不发送正式数据包。请在反作弊或需要即时断开的紧急情况下使用此方法。

HamsterPlayer hamsterPlayer = HamsterAPI.getInstance().getHamsterPlayerManager().get(player);

hamsterPlayer.closeChannel();
将玩家发送到另一个 BungeeCord 服务器
HamsterPlayer hamsterPlayer = HamsterAPI.getInstance().getHamsterPlayerManager().get(player);

```java
// 服务器名称必须与你的 BungeeCord config.yml 中的名称匹配
hamsterPlayer.sendServer("lobby-1");

路线图:HamsterAPI 的未来

我们正不断努力扩展 API 的功能。以下是即将推出的内容:

  • BossBar API: 一种简单、与版本无关的方式来创建和管理自定义 BossBars。
  • 自定义插件通道: 启用服务端插件与客户端模组之间的直接通信。
  • BungeeCord 监听器: 一个专用的监听器,用于接收来自 BungeeCord 代理的插件消息。

立即开始使用 HamsterAPI,全面掌控你服务器的网络通信

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源