Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: shape formal docs #71

Merged
merged 4 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,40 @@
# bilive
<div align="center">
<picture>
<img src="assets/header.svg" alt="BILIVE" />
</picture>

*7 x 24 小时无人监守录制、渲染弹幕、自动上传,启动项目,人人都是录播员。*

[:page_facing_up: Documentation](#major-features) |
[:gear: Installation](#quick-start) |
[:thinking: Reporting Issues](https://github.com/timerring/bilive/issues/new/choose)

</div>

## Introduction

> 7 x 24 小时无人监守弹幕版录播上传,启动项目,人人都是录播员。
>
> 如果您觉得项目不错,欢迎 :star: 也欢迎 PR 合作,如果有任何疑问,欢迎提 issue 交流。

自动监听并录制B站直播和弹幕、自动转换xml弹幕(含付费留言、礼物等)为ass并压制进视频,自动投稿**弹幕版视频**和**无弹幕视频**至B站,无需GPU,兼容超低配置服务器与主机,**兼容Windows 和 linux操作系统**。


Feature:
### Major features

- **速度快**:录制的同时可以选择启动无弹幕版视频的上传进程,下播延迟检测后即可直接上线平台。
- **范围广**:多线程同时监听数个直播间,同时录制内容并投稿。
- **空间小**:自动删除已上传的往期直播回放,节省空间,硬盘空间可以重复利用。
- **灵活高**:模版化自定义投稿,支持自定义投稿分区,动态内容,视频描述,视频标题,视频标签等,同时支持多P上传。
- **自动检测合并**:对于网络问题或者连线导致的视频流分段,支持自动检测并按小时合并视频片段。
- **弹幕版视频**:录制视频同时录制弹幕文件(包含普通弹幕,付费弹幕以及礼物上舰等信息),支持自动转换xml为ass弹幕文件并且压制到视频中形成**有弹幕版视频**,转换完成后即在上传队列中自动上传。
- **硬件要求低**:无需GPU,只需最基础的单核CPU搭配最低的运存即可完成录制,压制,上传等等全部过程,15年前的电脑或服务器依然可以使用!
- **硬件要求低**:无需GPU,只需最基础的单核CPU搭配最低的运存即可完成录制,压制,上传等等全部过程,10年前的电脑或服务器依然可以使用!

> [!TIP]
> 关于压制速率:与弹幕数量有关,测试硬件的基本区间 2核Intel(R) Xeon(R) Platinum 85 的 CPU 的压制速率在 3 ~ 6 倍之间,也可使用 Nvidia 1650 GPU 加速则压制速率在 16 ~ 20 倍之间。 差距在可接受范围内。如需使用 Nvidia GPU 加速,
> 请参考:
> + [Using FFmpeg with NVIDIA GPU Hardware Acceleration](https://docs.nvidia.com/video-technologies/video-codec-sdk/12.0/ffmpeg-with-nvidia-gpu/index.html)
> + [使用GPU为FFmpeg 加速](https://yukihane.work/li-gong/ffmpeg-with-gpu)

## 快速使用
## Quick start
### 测试硬件
+ OS: Ubuntu 22.04.4 LTS

Expand All @@ -32,6 +45,7 @@ Feature:
+ 硬盘:40G
+ 带宽: 3Mbps
> 个人经验:若想尽可能快地更新视频,主要取决于上传速度而非弹幕压制速度,因此建议带宽越大越好。

### 环境
```
pip install -r requirements.txt
Expand Down
24 changes: 24 additions & 0 deletions assets/header.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.