@iwpz/fishpi-dsh 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,166 @@
1
- # Temporary Holding Version
1
+ # 摸鱼派(FishPi)聊天室 for DSH
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ 把 [摸鱼派 / FishPi](https://fishpi.cn) 在线聊天室放进 DeepSeek Harness 的右侧边栏,并在 DSH 设置中登录鱼排账号。
4
+
5
+ - npm:<https://www.npmjs.com/package/@iwpz/fishpi-dsh>
6
+ - GitHub:<https://github.com/FishPiOffical/fishpi-dsh>
7
+ - 包名:`@iwpz/fishpi-dsh`
8
+ - 当前版本:`0.1.0`
9
+
10
+ ![DSH 右侧边栏中的摸鱼派聊天室](docs/screenshot.jpg)
11
+
12
+ ## 功能
13
+
14
+ ### 聊天室
15
+
16
+ - 右侧边栏标签页:从边栏 `+` 指南卡片打开「摸鱼派聊天室」,或点会话标题栏的鱼形按钮。
17
+ - 最近消息 + 上拉加载历史;实时接收新消息、编辑、撤回和连接状态变化。
18
+ - 显示当前话题、在线人数、连接状态和未读数量。
19
+ - 发送 Markdown;自己的消息靠右显示。
20
+ - 输入框自动增高,不显示垂直滚动条;发送按钮在输入框右侧。
21
+ - 输入框左侧 `+` 可选择多张图片,支持直接粘贴剪贴板图片;上传后插入 Markdown 图片。
22
+ - 富文本模式渲染鱼排清洗后的 Markdown / 图片 / 链接;纯文本模式只显示文字,图片显示为 `[图片]` / `[Image]`。
23
+ - 链接在外部浏览器打开。
24
+
25
+ ### 红包
26
+
27
+ - 红包卡片标题显示类型:拼手气、普通、专属、心跳、猜拳。
28
+ - 点击红包打开领取明细和领取入口。
29
+ - 普通/拼手气/专属/心跳:勾选确认后可直接点卡片领取。
30
+ - 猜拳红包:卡片上直接显示 `[石] [剪] [布]`,点击即按对应出拳领取,不需要额外勾选。
31
+ - 已领取或已抢完的猜拳红包不再显示出拳按钮。
32
+ - 弹窗中的领取明细保持中立,不额外显示个人账目。
33
+
34
+ ### @ 提及
35
+
36
+ - 输入 `@` 弹出用户候选。
37
+ - 在线用户按用户名/昵称模糊匹配,其他用户通过鱼排用户名联想接口搜索。
38
+ - 支持 `↑` / `↓` 选择,`Enter` / `Tab` 确认,`Esc` 关闭,也可以鼠标点击。
39
+ - 选中后插入 `@用户名 `,鱼排服务端会发出真正的提及通知。
40
+
41
+ ### 用户资料与勋章
42
+
43
+ - 消息头像、昵称/用户名,红包领取记录里的头像和名字,红包发送者,都可以点击打开资料卡。
44
+ - 资料卡显示头像、`昵称(用户名)`、角色、编号、位置(资料公开时)、积分、累计在线时长、简介。
45
+ - 「主页」按钮直接打开 `https://fishpi.cn/member/<用户名>`。
46
+ - 勋章在资料卡中显示完整图标 + 名称 + 描述。
47
+ - 聊天窗口昵称后方显示 14px 勋章图标微缩版,悬停可看名称和描述。
48
+
49
+ ### 通知与外观
50
+
51
+ - 未读标记显示在标签标题和会话标题栏鱼形按钮上。
52
+ - 可选桌面通知;聊天室不在前台时提醒新消息,点击通知可打开聊天室。
53
+ - 设置项图标、会话入口和侧栏指南卡片播放鱼排首页 `#logo-animate` 的猫咪 + 鱼动画;插件管理器图标为同一动画生成的动态 WebP。
54
+ - 跟随 DSH 浅色/深色主题。
55
+
56
+ ## 安装
57
+
58
+ 插件同时发布在 npm、GitHub 和 GitHub 源码压缩包中。任选一种方式即可,不需要构建步骤。
59
+
60
+ ### 方式一:npm(推荐)
61
+
62
+ 1. 打开 DSH 的 **Plugins** 页面。
63
+ 2. 点 **Add plugin**,输入:
64
+ ```
65
+ @iwpz/fishpi-dsh
66
+ ```
67
+ 或指定版本:
68
+ ```
69
+ @iwpz/fishpi-dsh@0.1.0
70
+ ```
71
+ 3. 安装后启用插件,刷新页面。
72
+
73
+ npm 页面:<https://www.npmjs.com/package/@iwpz/fishpi-dsh>
74
+
75
+ ### 方式二:GitHub
76
+
77
+ 直接通过 Git 地址安装(当前 DSH 版本的 Add plugin 接受 Git spec 时):
78
+
79
+ 1. **Plugins → Add plugin**,输入:
80
+ ```
81
+ git+https://github.com/FishPiOffical/fishpi-dsh.git
82
+ ```
83
+ 2. 启用并刷新页面。
84
+
85
+ 如果当前版本只接受本地目录,克隆后选择目录:
86
+
87
+ ```sh
88
+ git clone https://github.com/FishPiOffical/fishpi-dsh.git
89
+ ```
90
+
91
+ 然后在 **Plugins → Add plugin** 中选择克隆下来的 `fishpi-dsh` 文件夹。
92
+
93
+ ### 方式三:ZIP
94
+
95
+ 1. 下载 GitHub 源码压缩包:
96
+ <https://github.com/FishPiOffical/fishpi-dsh/archive/refs/heads/main.zip>
97
+ (也可以打开 GitHub 仓库,Code → Download ZIP。)
98
+ 2. 解压,得到 `fishpi-dsh-main` 文件夹。
99
+ 3. DSH **Plugins → Add plugin** → 选择解压后的文件夹。
100
+ 4. 启用插件并刷新页面。
101
+
102
+ GitHub 生成的 ZIP 不包含 `.git`;仓库里的测试和 `refs/API-v3.md` 参考文档会一并包含。
103
+
104
+ ### 从本地目录安装(开发)
105
+
106
+ 如果已经在本机 checkout:
107
+
108
+ 1. **Plugins → Add plugin**。
109
+ 2. 选择本仓库目录(包含 `package.json` 和 `cordis.patch.yml`)。
110
+ 3. 启用插件。
111
+
112
+ ## 登录与使用
113
+
114
+ 1. 打开 **Settings → 摸鱼派**。
115
+ 2. 输入鱼排用户名或邮箱、密码;两步验证码输入框会一直显示,未开启两步验证时留空即可。
116
+ 3. 勾选「记住密码」时,密码的 MD5 摘要会保存在 DSH 凭据库,用于访问令牌过期后自动重新登录;两步验证账号仍需手动输入验证码。
117
+ 4. 还没有账号可以点登录表单里的「去注册」,跳转鱼排注册页。
118
+ 5. 从会话标题栏鱼形按钮或右侧边栏 `+` 指南卡片打开聊天室。
119
+ 6. 在设置中选择富文本/纯文本,以及是否启用桌面通知。
120
+
121
+ ## 凭据与数据
122
+
123
+ - 访问令牌和可选的密码摘要保存在本机 DSH 凭据库的记录 `fishpi-chat/account` 中,不写入 `cordis.patch.yml`,也不放进 localStorage。
124
+ - 页面只通过 DSH 同源的 `api/fishpi/*` 认证路由访问 Host;密码和 token 不会进入页面。
125
+ - 鱼排登录由 DSH Host 发起;聊天室 WebSocket 也由 Host 维持,页面不直接调用鱼排 API。
126
+ - 富文本中的图片由页面从鱼排图床加载。
127
+ - 退出登录会删除凭据记录。
128
+
129
+ ## 限制
130
+
131
+ - 鱼排登录接口不允许浏览器跨域,因此登录必须在 Host 完成。
132
+ - 两步验证账号的访问令牌过期后,需要重新输入密码和验证码。
133
+ - 聊天室必须在有会话的情况下使用;没有活动会话时没有右侧边栏入口。
134
+ - 暂不支持表态(reactions)、撤回、弹幕和修改话题。
135
+ - 图片直接从鱼排图床加载;默认不做模糊处理。
136
+ - 插件基于 [鱼排 API v3](https://github.com/FishPiOffical/rhythm/blob/api_v3/API.md),第三方行为可能与第一方网页不同。
137
+
138
+ ## 卸载
139
+
140
+ 在 **Plugins** 中移除或停用 `@iwpz/fishpi-dsh`,然后刷新页面。凭据记录不会随插件移除自动删除;需要彻底清理时请在 DSH 凭据管理中删除 `fishpi-chat/account`。
141
+
142
+ ## 开发
143
+
144
+ 没有构建步骤:
145
+
146
+ - `index.js`:Host 路由、登录、凭据、WebSocket 生命周期。
147
+ - `fishpi.js`:FishPi HTTP / WebSocket 客户端。
148
+ - `client.js`:浏览器模块,注册右侧边栏、设置页、会话按钮、用户资料和红包界面。
149
+ - `locale/en.json`、`locale/zh.json`:插件管理器展示元数据。
150
+ - `test/`:Node 测试。
151
+
152
+ 运行测试:
153
+
154
+ ```sh
155
+ node --test test/fishpi.test.mjs test/host.test.mjs test/client.test.mjs
156
+ ```
157
+
158
+ 检查 npm 打包内容:
159
+
160
+ ```sh
161
+ npm pack --dry-run
162
+ ```
163
+
164
+ ## 致谢与声明
165
+
166
+ - 鱼排 Logo 与 `#logo-animate` 动画来自 [fishpi.cn](https://fishpi.cn);公开分发/再发布前请确认鱼排的品牌与素材授权。