# 摸鱼派聊天室 VSCode 扩展

基于摸鱼打工人社区——[摸鱼派](https://fishpi.cn)开放 API 开发的聊天室扩展，可以在里面边写 Bug 边愉快地吹水摸鱼。 。

## 功能

- 💬 基本聊天吹水；
- 🧧 领取/发送积分红包；
- 😎 内置表情包(按下`:`加字母调出表情列表)和自定义表情包；
- 📷 上传发送图片；
- ☁️ 同步收藏表情包；
- 📦 消息菜单列表（`@`用户，回复消息，收藏表情，撤回消息）；
- 📜 Hook 脚本注入。

![](media/preview.png)

## 扩展设置

- `pwl-chat.viewType`: 设置聊天室显示模式，文字模式将隐藏一切图片与大多数样式。默认为`图文模式`。
- `pwl-chat.hook`: 扩展注入脚本本地路径。[[开发说明]](#扩展注入)

## 扩展注入

通过注入自定义脚本来扩展其功能。[示例代码](./hook.js)

- `init(context:ExtensionContext, apiKey:string)`: 载入脚本后初始化
  * `context`: vscode 扩展 context 对象。
  * `apiKey`: 用户 API Key，若未登录则为空字符串, 可用于调用摸鱼派 API，API 文档：https://fishpi.cn/article/1636516552191
- `loginEvent(apiKey:string, user:any)`: 登录事件
  * `apiKey`: 用户 API Key
  * `user`: 登录用户信息
- `logoutEvent`: 退出登录事件
- `async messageEvent({ type:string, data:any }):boolean`: 聊天室消息事件，return true 表示响应该消息，false 则会中断消息响应。比如可以对指定人的消息进行屏蔽
  * `type`: 消息类型。
  * `data`: 消息内容，不同类型包含不同数据，详情见[示例代码](./hook.js)。
- `async sendMsgEvent(text:string):string`: 聊天室发送消息事件，return 你要发送的内容，不发送则返回空。
  * `text`: 用户发送的聊天消息，包含复读消息，红包消息。
- `liveness(data:number)`: 活跃度获取，登录后定时每 60s 触发一次。
  * data 活跃度数据  

 
## Release Notes

### 0.0.21
- 支援弹幕功能；
- 支援话题功能；
- 支援进出消息显示；

### 0.0.20
- 移除多余尾巴；

### 0.0.19
- 更新 LOGO；

### 0.0.18
- 修正来源标识；

### 0.0.17
- 添加发送来源；

### 0.0.16
- 添加猜拳红包支援；
- 添加消息来源标记；

### 0.0.15
- 更新 Emoji 地址

### 0.0.14
- 添加二次登录码。

### 0.0.12
- 修正消息事件 Hook 不能拦截问题。

### 0.0.11
- 加入 API Key 失效自动登录功能；
- 加入扩展脚本注入设置功能。

### 0.0.10
- 修正登录注销不同步更新 UI 问题；
- 修正管理员角色不能撤回消息问题；
- 新增语音播放功能；

### 0.0.9
- 更新域名。

### 0.0.8
- 修正复读折叠撤回 Bug。
- 添加发送红包功能。

### 0.0.7
- 修正登录后没有重新获取表情包问题；
- 修正连发红包被折叠问题；
- 修正历史红包可能合并问题；
- 加入圣诞节彩蛋。

### 0.0.6
- 修正回复功能不可用问题；
- 加入复读合并功能；
- 加入设置选项 `View Type`，用于设置显示模式。

### 0.0.5
- 加入消息菜单，可以`@`用户，回复消息，收藏表情，撤回消息等；
- 加入表情包功能；

### 0.0.4
- 加入图片上传功能

### 0.0.3
- 紧急维护，修改活跃度更新频次，提升服务器稳定性。

### 0.0.2
- 加入积分红包领取功能。
- 加入`@`和内置表情提示。

### 0.0.1
- 完成初版。



## 前端调试说明
1. 按下 `Ctrl + Shift + P` 选择 `Task: Run Task`，运行 `vue serve` Task。
2. 按 `F5` 启动，调试前端代码使用 VSCode 的 Developer Tools (`Ctrl + Shift + I`)。
3. 在 Developer Tools 找到 `webviewview-pwl-chat-chatview` 中的 `active-frame` 中的 `localhost`，修改前端代码 (`views`目录) 会实时更新。
-----------------------------------------------------------------------------------------------------------
**Enjoy!**