mirror of
https://github.com/xfgryujk/blivechat.git
synced 2025-01-13 13:50:10 +08:00
更新readme
This commit is contained in:
parent
2187dfc167
commit
801280efbd
78
README.md
78
README.md
@ -1,26 +1,29 @@
|
||||
# blivechat
|
||||
用于OBS的仿YouTube风格的bilibili直播评论栏
|
||||
|
||||
![OBS截图](https://github.com/xfgryujk/blivechat/blob/master/screenshots/obs.png)
|
||||
![Chrome截图](https://github.com/xfgryujk/blivechat/blob/master/screenshots/chrome.png)
|
||||
![样式生成器截图](https://github.com/xfgryujk/blivechat/blob/master/screenshots/stylegen.png)
|
||||
![OBS截图](./screenshots/obs.png)
|
||||
![Chrome截图](./screenshots/chrome.png)
|
||||
![样式生成器截图](./screenshots/stylegen.png)
|
||||
|
||||
## 特性
|
||||
* 兼容YouTube直播评论栏的样式
|
||||
* 金瓜子礼物模仿醒目留言显示
|
||||
* 付费礼物模仿醒目留言显示
|
||||
* 高亮舰队、房管、主播的用户名
|
||||
* 支持屏蔽弹幕、合并相似弹幕等设置
|
||||
* 自带样式生成器
|
||||
* 支持自动翻译弹幕、醒目留言到日语
|
||||
* 支持标注打赏用户名的读音(拼音和日文假名)
|
||||
* 自带两种样式生成器,经典YouTube风格和仿微信风格
|
||||
* 支持自动翻译弹幕、醒目留言到日语,可以在后台配置翻译目标语言
|
||||
* 支持标注打赏用户名的读音,可选拼音或日文假名
|
||||
* 支持配置自定义表情,不需要开通B站官方表情
|
||||
|
||||
## 使用方法
|
||||
以下几种方式任选一种即可
|
||||
|
||||
### 一、本地使用
|
||||
1. 下载[发布版](https://github.com/xfgryujk/blivechat/releases)(仅提供x64 Windows版)
|
||||
2. 双击`blivechat.exe`运行服务器,或者用命令行可以指定host和端口号:
|
||||
```bat
|
||||
blivechat.exe --host 127.0.0.1 --port 12450
|
||||
```
|
||||
```sh
|
||||
blivechat.exe --host 127.0.0.1 --port 12450
|
||||
```
|
||||
3. 用浏览器打开[http://localhost:12450](http://localhost:12450),输入房间ID,复制房间URL
|
||||
4. 用样式生成器生成样式,复制CSS
|
||||
5. 在OBS中添加浏览器源,输入URL和自定义CSS
|
||||
@ -35,42 +38,41 @@
|
||||
请优先在本地使用,使用公共服务器会有更大的延迟,而且服务器故障时可能发生直播事故
|
||||
|
||||
* [公共服务器](http://chat.bilisc.com/)
|
||||
* [仅样式生成器](https://style.vtbs.moe/)
|
||||
|
||||
### 三、源代码版(自建服务器或在Windows以外平台)
|
||||
0. 由于使用了git子模块,clone时需要加上`--recursive`参数:
|
||||
```sh
|
||||
git clone --recursive https://github.com/xfgryujk/blivechat.git
|
||||
```
|
||||
如果已经clone,拉子模块的方法:
|
||||
```sh
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
```sh
|
||||
git clone --recursive https://github.com/xfgryujk/blivechat.git
|
||||
```
|
||||
如果已经clone,拉子模块的方法:
|
||||
```sh
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
1. 编译前端(需要安装Node.js):
|
||||
```sh
|
||||
cd frontend
|
||||
npm i
|
||||
npm run build
|
||||
```
|
||||
```sh
|
||||
cd frontend
|
||||
npm i
|
||||
npm run build
|
||||
```
|
||||
2. 运行服务器(需要Python3.6以上版本):
|
||||
```sh
|
||||
pip3 install -r requirements.txt
|
||||
python3 main.py
|
||||
```
|
||||
或者可以指定host和端口号:
|
||||
```sh
|
||||
python3 main.py --host 127.0.0.1 --port 12450
|
||||
```
|
||||
```sh
|
||||
pip3 install -r requirements.txt
|
||||
python3 main.py
|
||||
```
|
||||
或者可以指定host和端口号:
|
||||
```sh
|
||||
python3 main.py --host 127.0.0.1 --port 12450
|
||||
```
|
||||
3. 用浏览器打开[http://localhost:12450](http://localhost:12450),以下略
|
||||
|
||||
### 四、Docker(自建服务器)
|
||||
1. ```sh
|
||||
docker run --name blivechat -d -p 12450:12450 \
|
||||
--mount source=blc-data,target=/blivechat/data \
|
||||
--mount source=blc-log,target=/blivechat/log \
|
||||
--mount source=blc-frontend,target=/blivechat/frontend/dist \
|
||||
xfgryujk/blivechat:latest
|
||||
```
|
||||
1. ```sh
|
||||
docker run --name blivechat -d -p 12450:12450 \
|
||||
--mount source=blc-data,target=/blivechat/data \
|
||||
--mount source=blc-log,target=/blivechat/log \
|
||||
--mount source=blc-frontend,target=/blivechat/frontend/dist \
|
||||
xfgryujk/blivechat:latest
|
||||
```
|
||||
2. 用浏览器打开[http://localhost:12450](http://localhost:12450),以下略
|
||||
|
||||
## 自建服务器相关补充
|
||||
|
Loading…
Reference in New Issue
Block a user