Forráskód Böngészése

update readme, check for required config items

Mike L 4 éve
szülő
commit
78915935a4
3 módosított fájl, 14 hozzáadás és 11 törlés
  1. 12 11
      README.md
  2. 1 0
      dist/main.js
  3. 1 0
      src/main.ts

+ 12 - 11
README.md

@@ -1,8 +1,8 @@
-# Mirai Twitter Bot
+# (WIP) GoCQHTTP Twitter Bot
 
 修改自:[rikakomoe/cqhttp-twitter-bot](https://github.com/rikakomoe/cqhttp-twitter-bot)
 
-使用 API:[YunYouJun/mirai-ts](https://github.com/YunYouJun/mirai-ts)
+使用 API:[koishijs/koishi](https://github.com/koishijs/koishi)
 
 ## 主要区别
 
@@ -11,9 +11,9 @@
 - 处理订阅链接时大小写不敏感,新订阅链接时先检查是否存在
 - 支持直接查看指定的推文链接,或(在没有其他用户订阅该用户时)从最新推文回溯到该条推文,由新到旧显示
 - 图片使用 [sharp](https://github.com/lovell/sharp) 压缩为 JPEG
-- 视频使用 [gifski](https://github.com/ImageOptim/gifski) 压缩为 GIF(请务必下载并放到 `PATH` 下,推荐[这里](https://github.com/CL-Jeremy/gifski/releases/tag/1.0.1-unofficial)的最新修改版,注意从包管理器安装依赖)
+- 视频直接作为短视频发送
 - 机器人的 QQ 号码必须手动填写
-- Puppeteer 不再自动启动,请手动开启并监听本地 9222 端口(这种方式可以使用 Chrome 或是远程 WebSocket 代理服务器
+- 由于推特改版后引发了 Chromium 的 bug,截图部分从 Puppeteer 改为 Playwright 并使用特殊的 WebSocket 格式 URL(这种方式可以使用本地或远程 WebSocket 代理服务器上的 Playwright 服务端
 - 自动处理<u>来自群友的好友请求</u>和<u>来自好友的加群邀请</u>
 
 ## 配置
@@ -22,15 +22,16 @@
 
 | 配置项 | 说明 | 默认 |
 | --- | --- | --- |
-| mirai_access_token | Mirai HTTP API authKey(需与插件一致,插件若未<br />配置本项会在 console 显示生成值,请将其填入) | (必填) |
-| mirai_http_host | Mirai HTTP API 插件服务端地址 | 127.0.0.1 |
-| mirai_http_port | Mirai HTTP API 插件服务端口 | 8080 |
-| mirai_bot_qq | Mirai HTTP API 登录的目标机器人 QQ 号 | 10000(示例值,必填) |
+| cq_access_token | OneBot HTTP API authKey(需与插件一致,插件若未<br />配置本项会在 console 显示生成值,请将其填入) | (必填) |
+| cq_http_host | OneBot HTTP API 插件服务端地址 | 127.0.0.1 |
+| cq_http_port | OneBot HTTP API 插件服务端口 | 8080 |
+| cq_bot_qq | OneBot HTTP API 登录的目标机器人 QQ 号 | 10000(示例值,必填) |
 | twitter_consumer_key | Twitter App consumer_key | (必填) |
 | twitter_consumer_secret |  Twitter App consumer_secret | (必填) |
 | twitter_access_token_key | Twitter App access_token_key | (必填) |
 | twitter_access_token_secret | Twitter App access_token_secret | (必填) |
 | mode | 工作模式,0 为图文模式,1 为纯文本模式,2 为文<br />本附图模式 | 0 |
+| playwright_ws_spec_endpoint | Playwright 配置拉取 URL,内容格式为:<br />`{<浏览器>:<开发工具 WebSocket 端点 URL>}` | [http://127.0.0.1:8080<br />/playwright-ws.json](http://127.0.0.1:8080/playwright-ws.json)<br />(示例值,模式 0 时必填) |
 | resume_on_start | 是否在启动时从退出时的进度继续(拉取本应用非活<br />动时期错过的推文) | false |
 | work_interval | 对单个订阅两次拉取更新的最少间隔时间(秒) | 60 |
 | webshot_delay | 抓取网页截图时等待网页加载的延迟时长(毫秒) | 10000 |
@@ -41,10 +42,10 @@
 
 ## Bug
 
-- 好友消息的图片有可能会失效或直接无法接收(后者会被转换为 `[失败的图片:<地址>]` 格式,然后整条消息会以纯文本模式重发
-- 视频为实验性功能,可能会有各种问题,比如超过大小后会被服务器二压,暂时请酌情自行处理
+- 好友消息的图片有可能会失效或直接无法接收(由于更换后台框架,暂时无法进行进一步处理
+- 视频为实验性功能,可能会有各种问题
 
 ## Todo
 
 - 重新实现基于 hash 的文件缓存和转推媒体去重
-- 添加选项对时间线进行过滤
+- 添加选项对时间线进行过滤(目前可以在搜索时指定一些条件,但无法用于订阅,具体请使用 `/help` 查看文档)

+ 1 - 0
dist/main.js

@@ -48,6 +48,7 @@ catch (e) {
 }
 const requiredFields = [
     'twitter_consumer_key', 'twitter_consumer_secret', 'twitter_access_token_key', 'twitter_access_token_secret',
+    'cq_bot_qq', (config.mode || exampleConfig.mode) === 0 && 'playwright_ws_spec_endpoint',
 ];
 const warningFields = [
     'cq_http_host', 'cq_http_port', 'cq_access_token',

+ 1 - 0
src/main.ts

@@ -57,6 +57,7 @@ try {
 
 const requiredFields = [
   'twitter_consumer_key', 'twitter_consumer_secret', 'twitter_access_token_key', 'twitter_access_token_secret',
+  'cq_bot_qq', (config.mode || exampleConfig.mode) === 0 && 'playwright_ws_spec_endpoint',
 ];
 
 const warningFields = [