huya-danma-listener/README.md

huya danmu module

# huya-danmu

原始仓库：https://github.com/BacooTang/huya-danmu

huya-danmu 是Node.js版本虎牙直播弹幕监听模块。

简单易用，使用不到三十行代码，你就可以使用Node.js基于弹幕进一步开发。

## FIXED

@20210626

来自：https://github.com/damonpeng/huya-danmu-fix#readme

1. 虎牙改版，数据结构发生了变化
2. skipField 方法补充了 EN_INT64，避免采集时的 warning

@2024110

1. **支持esm，node>=18**
2. 返回了弹幕颜色

## Installation

可以通过本命令安装 huya-danma-listener:

```bash
npm install huya-danma-listener --save
```

## Simple uses

通过如下代码，可以初步通过Node.js对弹幕进行处理。

```javascript
const huya_danmu = require("huya-danma-listener");
const roomid = "910323";
const client = new huya_danmu(roomid);

client.on("connect", () => {
  console.log(`已连接huya ${roomid}房间弹幕~`);
});

client.on("message", (msg) => {
  switch (msg.type) {
    case "chat":
      console.log(`[${msg.from.name}]:${msg.content}`);
      break;
    case "gift":
      console.log(`[${msg.from.name}]->赠送${msg.count}个${msg.name}`);
      break;
    case "online":
      console.log(`[当前人气]:${msg.count}`);
      break;
  }
});

client.on("error", (e) => {
  console.log(e);
});

client.on("close", () => {
  console.log("close");
});

client.start();
```

## API

### 开始监听弹幕

```javascript
const huya_danmu = require("huya-danma-listener");
const roomid = "910323";
const client = new huya_danmu(roomid);
client.start();
```

### 使用socks5代理监听

```javascript
const huya_danmu = require("huya-danma-listener");
const roomid = "910323";
const proxy = "socks://name:pass@127.0.0.1:1080";
const client = new huya_danmu({ roomid, proxy });
client.start();
```

### 停止监听弹幕

```javascript
client.stop();
```

### 断线重连

```javascript
client.on("close", (_) => {
  client.start();
});
```

### 监听事件

```javascript
client.on("connect", (_) => {
  console.log("connect");
});

client.on("message", console.log);

client.on("error", console.log);

client.on("close", (_) => {
  console.log("close");
});
```

### msg对象

msg对象type有chat,gift,online三种值
分别对应聊天内容、礼物、在线人数

#### chat消息

```javascript
    {
        type: 'chat',
        time: '毫秒时间戳(服务器无返回time,此处为本地收到消息时间),Number',
        from: {
            name: '发送者昵称,String',
            rid: '发送者rid,String',
        },
        id: '弹幕唯一id,String',
        content: '聊天内容,String'
    }
```

#### gift消息

```javascript
    {
        type: 'gift',
        time: '毫秒时间戳(服务器无返回time,此处为本地收到消息时间),Number',
        name: '礼物名称,String',
        from: {
            name: '发送者昵称,String',
            rid: '发送者rid,String',
        },
        id: '唯一ID,String',
        count: '礼物数量,Number',
        price: '礼物总价值(单位Y币),Number',
        earn: '礼物总价值(单位元),Number'
    }
```

#### online消息

```javascript
    {
        type: 'online',
        time: '毫秒时间戳(服务器无返回time,此处为本地收到消息时间),Number',
        count: '当前人气值,Number'
    }
```