# blivemsg
一个功能简单的 Bilibili 直播间消息 WebSocket 客户端 Rust 库，仅支持实时直播间消息监控、不支持文字转语音（TTS）也不支持浏览器 Cookie 自动检测，提供强类型消息接口和 Stream API。
## ✨ 特性
- **52 种消息类型**：完整支持所有 B站直播消息类型
- **零拷贝解析** - 高效的 JSON 解析，最小化内存分配
## 🚀 快速开始
---
## 🛠️ CLI 工具
### 安装
```bash
# 方法 1：从 crates.io 安装
cargo install blivemsg --features cli
# 方法 2：下载可执行文件
[Releases](https://github.com/urlynn/blivemsg/releases)
```
### 快速使用
```bash
# 基本用法：指定直播间和 Cookie
blivemsg-cli -r 3151244 -c cookies.json
# 筛选指定消息类型
blivemsg-cli -c cookie.json -t "DANMU_MSG,SEND_GIFT"
# 使用配置文件
blivemsg-cli -C my_config.toml
```
### 命令行参数
```
Usage: blivemsg-cli [OPTIONS]
Options:
-r, --room-id <ROOM_ID> 直播间 ID [default: 3151244]
-c, --cookie <COOKIE> Cookie（JSON文件路径/JSON字符串/内联字符串）
-t, --message-types <TYPES> 消息类型筛选 [default: user]
-q, --quiet 静默模式（纯文本输出，适合管道处理）
-C, --config <CONFIG> 配置文件路径（TOML格式）
-h, --help Print help
-V, --version Print version
```
#### Cookie 输入方式（自动检测）
```bash
# 1. JSON 文件路径
-c cookies.json
# 2. JSON 字符串
-c '{"SESSDATA":"xxx","buvid3":"xxx"}'
# 3. 内联字符串
-c "SESSDATA=xxx;buvid3=xxx"
```
#### 消息类型筛选
```bash
# 预设类别
-t USER # 用户消息（默认）
-t SYSTEM # 系统消息
-t ALL # 全部消息
# 具体类型（逗号分隔）
-t DANMU_MSG # 弹幕
-t DANMU_MSG,SEND_GIFT # 弹幕+礼物
-t SUPER_CHAT_MESSAGE,GUARD_BUY # SC+舰长
```
**消息类型列表**：完整列表请参考 [MESSAGES.md](MESSAGES.md)
### 配置文件
```
# blivemsg.toml
room_id = 7734200
cookie = "cookies.json"
message_types = ["DANMU_MSG", "SEND_GIFT"]
```
**优先级**：命令行参数 > 配置文件 > 默认值
---
### 作为库使用（最小依赖）
- **异步流式 API** - 基于 `Stream` trait，符合 Rust 生态惯例
- **零拷贝解析** - 高效的 JSON 解析，最小化内存分配
- **类型安全** - 强类型消息定义，编译期错误检查
#### 添加到项目
```toml
[dependencies]
blivemsg = "0.2.0"
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
futures-util = "0.3"
```
**默认不包含的功能**：
- No CLI 工具
- No Protobuf 支持
- No 浏览器指纹模拟
#### 启用可选功能
```toml
[dependencies]
# 启用 Protobuf 支持（用于 INTERACT_WORD_V2 消息）
blivemsg = { version = "0.2.0", features = ["protobuf-support"] }
# 启用浏览器指纹模拟, 仅做备用选项, 可能增加稳定性
blivemsg = { version = "0.2.0", features = ["emulation"] }
# 启用所有功能
blivemsg = { version = "0.2.0", features = ["protobuf-support", "emulation"] }
```
#### Stream 模式（推荐）
```rust
use blivemsg::{BliveClient, types::Message};
use futures_util::StreamExt;
#[tokio::main]
async fn main() -> Result<(), blivemsg::Error> {
let mut client = BliveClient::new(7734200, "cookies.json")?;
let mut stream = client.stream().await?;
while let Some(message) = stream.next().await {
match message {
Message::Danmu(d) => println!("[{}] {}: {}", d.medal_level, d.username, d.content),
Message::Gift(g) => println!("{} 送了 {} x{}", g.username, g.gift_name, g.num),
Message::SuperChat(sc) => println!("[SC] ¥{:.2}", sc.price),
_ => {}
}
}
Ok(())
}
```
#### 回调模式
```rust
use blivemsg::BliveClient;
#[tokio::main]
async fn main() -> Result<(), blivemsg::Error> {
let mut client = BliveClient::new(7734200, "cookies.json")?;
client.on_danmu(|danmu| {
println!("[{}] {}: {}", danmu.medal_level, danmu.username, danmu.content);
}).await?;
Ok(())
}
```
## 📦 Features 说明
| `cli` | CLI 工具（**自动包含 protobuf-support**） | clap, toml, prost, bytes, base64 | 需要命令行工具 |
| `protobuf-support` | Protobuf 消息解析 | prost, bytes, base64 | 库用户需要 INTERACT_WORD_V2 消息 |
| `emulation` | 浏览器指纹模拟 | wreq-util | 高级反爬虫场景 |
| 默认（无） | 核心库功能 | 无 | 作为库集成到其他项目 |
---
## 📚 文档结构
- **[README.md](README.md)** - 快速开始和 CLI 使用指南（本文件）
- **[API.md](API.md)** - 库 API 详细文档
- **[MESSAGES.md](MESSAGES.md)** - 完整消息类型列表
---
## 🏗️ 架构设计
```
src/
├── lib.rs # 公共 API 导出
├── client.rs # BliveClient 实现
├── message.rs # 52 种消息类型定义
├── error.rs # 统一错误类型
└── internal/ # 私有实现（不导出）
├── ws.rs # WebSocket 连接
├── http.rs # HTTP API 调用
├── parser.rs # JSON → Message 转换
└── cookie.rs # Cookie 管理
```
---
## 📄 许可证
MIT
## 🔗 相关链接
- [GitHub](https://github.com/urlynn/blivemsg)
- [crates.io](https://crates.io/crates/blivemsg)
- [docs.rs](https://docs.rs/blivemsg)