补充使用说明和问题排查清单

2024-01-09 23:55:18 +08:00
parent a54ba2794b
commit db2128eaae
1 changed files with 61 additions and 16 deletions
@@ -1,10 +1,15 @@
 # 📺 抖音弹幕监听器
-+ Github大佬请移步[Gitee](https://gitee.com/haodong108/dy-barrage-grab)，参与Issues讨论，QQ讨论群:819927029(进群前请Star，谢谢🔪)
-+ 发行版下载地址在[这里](https://gitee.com/haodong108/dy-barrage-grab/releases)，别下成源码包了!!
-+ 💭 需要ws多直播间直连、拿直播间/用户主页信息、自动私信、自动发弹幕、获取榜单等功能的可以找我(QQ1083092844)提供一些技术支持(不支持匿名直播间)
+
+## 🔉前文提要
+
+ Github(受网络影响，更新很可能不及时)大佬请移步 [Gitee](https://gitee.com/haodong108/dy-barrage-grab) ，参与Issues讨论，QQ讨论群:819927029(进群前请⭐**Star**，谢谢🔪)
+ 发行版下载地址在[这里](https://gitee.com/haodong108/dy-barrage-grab/releases)，别下成源码包了!!，**决定下载使用前请先仔细阅读文档**，不要进群提问已经介绍到的问题
+ 💭 需要ws多直播间直连、自动私信，私信监听、自动发弹幕、获取榜单、礼物、直播间、用户主页信息、等功能的可以找我(QQ1083092844)提供一些技术支持(不支持匿名直播间)
+ 如果这个开源项目能帮老板们赚到玛尼，还望能请杯咖啡，支持我更新下去(见底部捐赠通道)

 ## ⛳近期更新
 2023-11-23 v2.7.0
+
 1. 修复了因抖音版本升级导致的WebRoomId获取不到的问题，并更近了正则表达式尽量兼容后续的变更
 2. 添加了winfrom窗体，功能有限，默认隐藏
 3. 支持了控制台隐藏，推送器弹幕类型过滤，日志弹幕类型过滤，弹幕文件日志  (见配置文件)
@@ -42,7 +47,9 @@

 ### <a id="tag1">配置文件</a>

-程序中有基本的配置可以过滤弹幕进程，弹幕数据通过Websocket服务推送，其他程序只需接入ws服务器就能接收到到弹幕数据消息
+程序中有基本的配置可以过滤弹幕进程，弹幕数据通过Websocket服务推送，其他程序只需接入ws服务器就能接收到到弹幕数据消息，
+
+若下载发行版，则该配置文件在根目录下的 **WssBarrageService.exe.config** 可自主配置，配置后需要重新启动程序

 ``` xml
 <!--配置更改后重启才能生效-->
@@ -73,8 +80,8 @@
    <add key="hostNameFilter" value=""/>
    <!--要进行过滤的房间ID,不填代表监听所有，多项使用','分隔，浏览器进入直播间 F12 控制台输入 'window.localStorage.playRoom' 即可快速看到房间ID(不是地址栏中的那个) -->
    <add key="roomIds" value=""/>
-	  <!--隐藏控制台-->
-	  <add key="hideConsole" value="false"/>
+	<!--隐藏控制台-->
+	<add key="hideConsole" value="false"/>
    <!--弹幕文件日志-->
    <add key="barrageFileLog" value="false"/>
    <!--显示窗体-->
@@ -84,27 +91,63 @@

 ### 推送数据格式

-弹幕数据由WebSocket服务进行分发，使用Json格式进行推送，见项目  [BarrageMessages.cs](./BarrageGrab/JsonEntity/BarrageMessages.cs)，如需调整请克隆项目后参照 [message.proto](./BarrageGrab/proto/message.proto) 进行源码修改调整，文件包含所有弹幕相关数据结构，可前往[ws在线测试](http://wstool.jackxiang.com/)网站，连接 ws://127.0.0.1:8888 进行测试
+弹幕数据由WebSocket服务进行分发，使用Json格式进行推送，见项目  [BarrageMessages.cs](./BarrageGrab/Modles/JsonEntity/BarrageMessages.cs)，如需调整请克隆项目后参照 [message.proto](./BarrageGrab/proto/message.proto) 进行源码修改调整，文件包含所有弹幕相关数据结构，可前往[ws在线测试](http://wstool.jackxiang.com/)网站，连接 ws://127.0.0.1:8888 进行测试

 ### 使用方法
 1. 管理员身份启动本程序，第一次启动会提示安装自签名证书，程序启动后挂在后台不要关，不然再打开会监听不到正在进行中的直播弹幕。
-2. 打开浏览器进入任何直播间进行测试，没有问题再启动直播伴侣，<b>浏览器和直播伴侣同时打开时还是要注意进程过滤，不然弹幕会杂交</b>
+2. 打开浏览器进入任何直播间进行测试，没有问题再启动直播伴侣
+3. 如果需要对接自己的应用程序，请先了解 [WebSocket](https://www.bilibili.com/video/BV1KN411n7WD/?share_source=copy_web&vd_source=39ebf42c923024b9eddeca32c9e46d16) ，然后进行对接，可前往[这里](http://wstool.jackxiang.com/)测试
+
+
+
+## 👨‍⚕️ 诊断排查

 ### 启动后无法获取，排查清单

 1. 先判断自己的浏览器进程名称是否在配置文件列表中
-
 2. 程序启动后，检查系统代理有无正常打开，有可能修改注册表被其他杀毒软件拦截
-
 3. 检查程序是否以管理员身份启动
-
 4. 注意程序启动先后顺序(很重要)，必须保证在进入直播间之前监听程序已在运行
-
 5. 检查代理端口是否与其他端口冲突，可尝试修改

-6. 依旧不行？请前往[这里]([电脑 - 商品搜索 - 京东 (jd.com)](https://search.jd.com/Search?keyword=电脑))
+### 打开报错，排查清单 
+
+  **通用处理方法：**
+  1. 关闭杀毒软件，杀毒软件可能会阻止注册系统代理，访问端口号
+  2. 关闭Windows网络防火墙(设置-搜索) ，可能会阻止访问端口号
+
+  **以一种访问权限不允许的方式做了一个访问套接字的尝试**
+  1. 可能是端口被占用了，请尝试前往配置文件将8888端口号修改为别的号码(1000~65535)
+  2. 关杀毒
+ **尝试执行未经授权的操作**
+  1. 关杀毒
+ 以上都不行
+  1. 请前往[这里](https://www.baidu.com/s?word=电脑购买)瞧瞧 
+
+### 浏览器总是连接一段时间后，就在在控制台看不到弹幕了
+
+ 优先使用Chrome 和 Edge 浏览器，其他浏览器(例如360浏览器) 已知会存在该问题
+ 其他可能是网络原因，或者直播间断连导致，正在想办法优化解决中。。。需要长时间连接可以找我使用其他方式，支持直连和轮询获取方式
+
+### 程序关闭后无法上网
+
+ 这是因为本程序运行时会占用系统代理，不正确的关闭方式可能会导致系统代理未能正确关闭，请前往找到 系统设置-网络和Internet-代理-使用代理服务器  并关闭它即可
+
+
+
+## 🎲 辅助功能支持
+
+ **隐藏控制台**：	见配置文件 `hideConsole`
+ **远程控制程序**，例如远程关闭，隐藏/显示控制台，启用/关闭系统代理：
+ 发送Json数据包 `{"Cmd":xx,"Data":xx}` 到ws推送地址，数据格式详见: [Command.cs](./BarrageGrab/Modles/JsonEntity/Command.cs)
+ **启用弹幕文件日志**：
+  + 见配置文件 `barrageFileLog`，启用后，抓到弹幕会记录在根目录 logs/弹幕日志 文件夹中，支持类型过滤，见`logFilter` 配置项
+
+ **上游代理设置**：
+  + 一般用于自己有 代理工具/代理服务器，希望在使用本程序时访问外网不受到影响，见配置文件项`upstreamProxy` 将它改为你代理工具的代理地址
+ **UI界面：**见配置文件 `showWindow `  (做的仓促，功能简陋)
+

-   

 ## 🖼️控制台截图

@@ -126,7 +169,9 @@

 ## 📢鸣谢

-+ 请施舍一个 ⭐Start ，现在工具处于早期版本，请及时订阅更新
+ 请施舍一个 ⭐Start ，请及时订阅更新
+
+ 如果你也是开发者，欢迎提交你所擅长的语言的对接Demo，照拂新手朋友

  

@@ -136,7 +181,7 @@

 ## 🍻支持一下?

-开源不易，你忍心白嫖是吧🤔~
+开源不易

 <p>
 <img src="./imgs/微信.png" alt="微信支付" style="zoom:70%;border-radius: 5px;" />