ProxLib

模组

· 作者 EnderKill98

使附近的玩家能够自主地互相通信。本质上是在 Minecraft 服务器上使用 CustomPayloadC2CPacket,无需任何集成即可实现。

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

最新 0.2.4+26.1 · 26.1 · Fabric

一键开服(送7天)

ProxLib

ProxLib 是一个库,允许 Minecraft 中的玩家进行基于距离的通信。它允许附近的玩家通过服务器直接互相交换数据,而无需服务器安装任何模组或插件来中继这些数据。

概述

ProxLib 为 ProxChat 提供动力,并可被其他模组使用以实现基于距离的通信功能。它提供了一个简单的 API,用于在彼此相距约 26 格以内的玩家之间发送和接收数据包。

该库通过将数据巧妙地编码到 Minecraft 现有的数据包系统中来实现工作,具体是通过方块破坏动作数据包(仅限中止操作),这些数据包会被中继给所有附近的玩家,且服务器不进行验证(是的,即使在空气中也能正常工作!)。

工作原理

  • 通信方式:使用带有 ABORT_DESTROY_BLOCK 动作的 PlayerActionC2SPacket
  • 数据编码:数据被编码到玩家周围的相对方块位置中
  • 范围:约 26 格(技术上受限于 Minecraft 的 32 格动作数据包中继范围)
  • 数据容量:每个 Minecraft 数据包 9 位
    • 发送的数据前会附加 2 个 Minecraft 数据包作为魔法值(用于识别其为 Prox 数据包),其中 2 字节用于供应商和包 ID,另外 3 字节用于包长度。
      • 因此,如果你发送一个包含 4 字节数据的数据包,这将变为 2 + (2 + 2 + 3 + 4) * (8 / 9) » 11.77 » 12 个 Minecraft 数据包
  • 可靠性:几乎适用于所有服务器,包括那些拥有反作弊系统的服务器
    • 请注意,反作弊系统可能会将其视为数据包垃圾邮件或某种奇怪的炸服尝试。这可能导致玩家因作弊而被标记。
      • 我的测试主要在 2b2t 上进行。反作弊系统没有阻止任何数据包,也没有踢出我,但最近的更新导致在发送数据和移动时出现延迟回退(数据仍然正常发送)。
    • 当你距离上下建筑限制不到约 6 格时停止工作(可能在世界边界附近也会失效)
    • 即使发送方处于创造模式也能正常工作!

免责声明: 由于此模组会发出大量上述 ABORT_DESTROY_BLOCK 数据包,反作弊系统可能会将玩家标记为数据包垃圾邮件发送者甚至炸服者(尽管真正的炸服者绝不会发送中止操作)。 因此,请确保玩家在启用相应的发送功能之前知晓这种情况可能发生。

安装

对于模组用户

ProxLib 是一个库模组,应与依赖它的模组一起安装。

模组可能会捆绑此库,除非你在游戏内模组菜单中查看库部分,否则你可能永远不会意识到它已被包含在内。

对于模组开发者

在你的 build.gradle 中将 ProxLib 添加为依赖项:

exclusiveContent {
    forRepository {
        maven {
            name = "Modrinth"
            url = "https://api.modrinth.com/maven"
        }
    }
    filter {
        includeGroup "maven.modrinth"
    }
}

dependencies {
    // 例如 MC 版本 1.21.4(请务必检查哪个是最新版本)。
    // 如果你不想将此模组直接捆绑到你的模组中,请移除 "include"(目前 <30 KiB)。
    include modApi("maven.modrinth:proxlib:0.2.4+1.21")
}

在你的 fabric.mod.json 中添加:

"depends": {
    "proxlib": ">=0.2.0"
}

构建

如果你希望构建此模组,你应该注意:

  • 该项目使用 Stonecutter 一次性生成多个版本
  • 你不应运行 build 任务,而是运行 chiseledBuild(在 project 类别中)
  • 有关更多信息,请参阅其文档

版本控制

一般来说,我尝试按照 SemVer(主版本.次版本.修订号)来处理版本号。

该库仍处于 1.0.0 之前的阶段。因此,稳定性可能并不完美。然而,该库可能永远无法达到 1.0.0,但当前版本仍然相当稳定。

特别是对于 ProxLib 类,我会尽力保持现有公共方法的兼容性。如果我破坏了兼容性,我会提升次版本号。但是,如果添加了大量新功能,我也可能会提升次版本号。所以这不一定意味着破坏性更改。

有关更改日志,请参阅 GitHub 上的发行版或 Modrinth 上的 changelog。

协议兼容性

自从 ProxChat 的第一个版本 于 2024 年 1 月发布以来,我就确定了协议,并且此后未对其做任何更改。

我的目标是永远不需要破坏兼容性。我也尽量对我的数据包做同样的事情。

迄今为止的唯一更改是:

  • ID (u16) 已拆分为 10 位供应商 ID 和 6 位数据包 ID。这不是破坏性更改,但改变了如何解释 ID。

开发者用法

数据包 ID

数据包由一个 2 字节的 ID 标识,该 ID 分为:

  • 10 位:供应商 ID(0 到 1023)
  • 6 位:数据包 ID(0 到 63)

因此,如果你想制作自己的数据包,你应该:

  • 选择你自己的供应商 ID。最好使用随机数生成器生成一个 ID 供你的模组使用。
  • 然后开始对任何数据包进行编号

示例:

final int VENDOR_ID = 932; // 使用随机数生成器生成
final ProxPacketIdentifier AWESOME_PACKET_ID = ProxPacketIdentifier.of(VENDOR_ID, 0);
final ProxPacketIdentifier ANOTHER_PACKET_ID = ProxPacketIdentifier.of(VENDOR_ID, 1);

发送与接收数据包

您可能需要的所有方法都可以轻松从 ProxLib 类中调用。

发送示例

public void sendAwesomePacket(String message) throws IOException {
  // 创建数据包的数据(byte[])
  ByteArrayOutputStream bytesOut = new ByteArrayOutputStream();
  DataOutputStream dataOut = new DataOutputStream(bytesOut);
  dataOut.writeByte(1); // 类型
  dataOut.writeUTF(message);

  // 发送数据包
  int packets = ProxLib.sendPacket(MinecraftClient.getInstance(), AWESOME_PACKET_ID, bytesOut.toByteArray());
  LOGGER.info("Sent my awesome packet using {} packets!", packets);
}

接收示例

public class MyAwesomeMod implements ClientModInitializer {

  @Override
  public void onInitializeClient() {
    ProxLib.addHandlerFor(AWESOME_PACKET_ID, (sender, identifier, data) -> {
      try {
        DataInputStream dataIn = new DataInputStream(new ByteArrayInputStream(data));
        int type = dataIn.readUnsignedByte(1);
        if(type == 1) {
            String message = dataIn.readUTF();
            // 对 message 进行处理...
        }else {
            LOGGER.warn("Received unsupported type in my awesome packet: {}", type);
        }
      } catch (IOException ex) {
        LOGGER.error("Failed to proccess my awesome packet!", ex);
      }
    });
    ProxLib.addHandlerFor(ANOTHER_PACKET_ID, (sender, identifier, data) -> {
      // ...
    });
  }

}

已知的数据包 ID:

Mod Vendor ID Packet ID Name Description Link
ProxChat 0 1 Chat Simple chat message in chat (type% <msg> with mod). PC-Chat
ProxChat 0 2 PatPat-PatEntity Petting someone (legcay) PC-Pat
ProxChat 0 3 EmoteCraft Play / Repeat / Stop own Emotes PC-Emote
ProxChat 0 4 TextDisplay Show one or more customizable text displays to others (type %% <msg> with mod). PC-TextDisplay
PatPat 2 0 Pat Patting someone PP-Pat

注意:ProxChat 的 Vendor ID 为 0,因为在当时 ID 尚未拆分为 Vendor ID 和 Packet ID(且该库是 ProxChat 的一部分)。因此使用了从 1 开始的数字,这实际上对应 Vendor ID 0,并且为了与旧版本的 ProxChat 保持向后兼容而保留下来。

与其他语言的集成

ItzN00bPvP 开发了一个与本项目兼容的 Rust 基础库(crates.io: proxchat,仓库: proxchat-rs)。如果您希望例如 azalea-bot 发送 ProxChat 消息,这将非常有用。

致谢

由 EnderKill98 开发,其基础是在检查他自己的 N00bBots 日志时偶然与 ItzN00bPvP 共同发现的。没有他,这个项目就不会存在!

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源