BililiveRecorder/README.md

# BiliBili Stream Recorder B站录播姬

[![Build and Test](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml/badge.svg)](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml)
[![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)
[![License](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)
[![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)

[简体中文 README | Simplified Chinese](README_CN.md)

GitHub is a global platform, and theoretically, everyone should use English. But since this project is mostly meant for Chinese user and rely on a Chinese website [BiliBili](https://live.bilibili.com) ([_wikipedia_](https://en.wikipedia.org/wiki/Bilibili)), all code comments are in Chinese. This README file will always use English so people like _you_ can understand what is this, and perhaps make some use out of it.

Software UI is available in

- 简体中文 (Source and default)
- 繁体中文
- 日本語
- English

## Install & Use

See [rec.danmuji.org](https://rec.danmuji.org) (in Chinese)

## Feature

- Easy to use
- Start recording automatically when stream starts
- Record multiple stream at same time
- Fix broken recording caused by broken bilibili stream server
- Toolbox mode to fix broken bilibili stream recording recorded by other software<sup>1</sup>
- Pure C#, no native dependency like ffmpeg<sup>2</sup>
- Open source!

<sup>1</sup>: Only unprocessed flv file downloaded directly from stream servers can be fixed. If the file is downloaded or processed by FFmpeg it no longer can be fixed, FFmpeg will fvck up the already broken recording even further.  
<sup>2</sup>: A minimal version of FFmpeg is bundled with the desktop edition of BililiveRecorder for the remux feature in toolbox.

## Develop & Build

Visual Studio 2019 with .NET 5 is recommended, though any other IDE should work too.

Project | Target | Note
:---:|:---:|:---:
BililiveRecorder.WPF | .NET Framework 4.7.2 | Windows only GUI
BililiveRecorder.Cli | .NET 5 | Cross-platform
BililiveRecorder.ToolBox | .NET Standard 2.0 | library used by WPF & Cli
BililiveRecorder.Core | .NET Standard 2.0 | Main recording logic
BililiveRecorder.Flv | .NET Standard 2.0 | Data processing logic

## Versioning

This project does not follow semantic versioning, no source code compatibility is guaranteed between any version.

## Reference & Acknowledgements

- [Adobe Flash Video File Format Specification 10.1.2.01.pdf](https://www.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10_1.pdf)
- [coreyauger/flv-streamer-2-file](https://github.com/coreyauger/flv-streamer-2-file) Used as a reference in the early stages of development
- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku) - (probably) first BiliBili stream recording tool.
Update README.md 2021-05-01 00:22:46 +08:00			`# BiliBili Stream Recorder B站录播姬`
Add Appveyor status badge [skip ci] 2018-03-25 15:23:48 +08:00
Update README.md 2021-05-01 00:48:37 +08:00			`[![Build and Test](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml/badge.svg)](https://github.com/Bililive/BililiveRecorder/actions/workflows/build.yml)`
update README [skip ci] 2018-04-17 12:26:12 +08:00			`[![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)`
Update README.md 2021-05-01 00:48:37 +08:00			`[![License](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)`
Update README.md 2021-05-01 00:22:46 +08:00			`[![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)`
init 2018-03-12 18:57:20 +08:00
Update README.md 2021-05-01 00:22:46 +08:00			`[简体中文 README \| Simplified Chinese](README_CN.md)`
init 2018-03-12 18:57:20 +08:00
update README 2021-01-09 16:47:28 +08:00			`GitHub is a global platform, and theoretically, everyone should use English. But since this project is mostly meant for Chinese user and rely on a Chinese website [BiliBili](https://live.bilibili.com) ([_wikipedia_](https://en.wikipedia.org/wiki/Bilibili)), all code comments are in Chinese. This README file will always use English so people like _you_ can understand what is this, and perhaps make some use out of it.`
update README [skip ci] 2018-03-31 17:05:16 +08:00
update README 2021-01-09 16:47:28 +08:00			`Software UI is available in`

			`- 简体中文 (Source and default)`
			`- 繁体中文`
			`- 日本語`
			`- English`
update README [skip ci] 2018-03-31 17:05:16 +08:00
			`## Install & Use`

			`See [rec.danmuji.org](https://rec.danmuji.org) (in Chinese)`

			`## Feature`

Fix typo 2018-04-07 20:30:34 +08:00			`- Easy to use`
Update README.md 2021-05-01 00:22:46 +08:00			`- Start recording automatically when stream starts`
update README [skip ci] 2018-03-31 17:05:16 +08:00			`- Record multiple stream at same time`
Update README.md 2021-05-01 00:22:46 +08:00			`- Fix broken recording caused by broken bilibili stream server`
Update README.md and about page 2021-11-20 15:02:50 +08:00			`- Toolbox mode to fix broken bilibili stream recording recorded by other software<sup>1</sup>`
			`- Pure C#, no native dependency like ffmpeg<sup>2</sup>`
update README [skip ci] 2018-03-31 17:05:16 +08:00			`- Open source!`

Update README.md and about page 2021-11-20 15:02:50 +08:00			`<sup>1</sup>: Only unprocessed flv file downloaded directly from stream servers can be fixed. If the file is downloaded or processed by FFmpeg it no longer can be fixed, FFmpeg will fvck up the already broken recording even further.`
			`<sup>2</sup>: A minimal version of FFmpeg is bundled with the desktop edition of BililiveRecorder for the remux feature in toolbox.`
update README [skip ci] 2018-03-31 17:05:16 +08:00
Update README.md 2021-05-01 00:22:46 +08:00			`## Develop & Build`
update README [skip ci] 2018-03-31 17:05:16 +08:00
Update README.md 2021-05-01 00:22:46 +08:00			`Visual Studio 2019 with .NET 5 is recommended, though any other IDE should work too.`
update README [skip ci] 2018-03-31 17:05:16 +08:00
Update README.md 2021-05-01 00:22:46 +08:00			`Project \| Target \| Note`
			`:---:\|:---:\|:---:`
			`BililiveRecorder.WPF \| .NET Framework 4.7.2 \| Windows only GUI`
			`BililiveRecorder.Cli \| .NET 5 \| Cross-platform`
			`BililiveRecorder.ToolBox \| .NET Standard 2.0 \| library used by WPF & Cli`
			`BililiveRecorder.Core \| .NET Standard 2.0 \| Main recording logic`
			`BililiveRecorder.Flv \| .NET Standard 2.0 \| Data processing logic`
update README [skip ci] 2018-03-31 17:05:16 +08:00
Update README 2021-05-18 22:41:35 +08:00			`## Versioning`

			`This project does not follow semantic versioning, no source code compatibility is guaranteed between any version.`

update README [skip ci] 2018-03-31 17:05:16 +08:00			`## Reference & Acknowledgements`

update README 2019-11-24 08:40:01 +08:00			`- [Adobe Flash Video File Format Specification 10.1.2.01.pdf](https://www.adobe.com/content/dam/acom/en/devnet/flv/video_file_format_spec_v10_1.pdf)`
Update README.md 2021-05-01 00:22:46 +08:00			`- [coreyauger/flv-streamer-2-file](https://github.com/coreyauger/flv-streamer-2-file) Used as a reference in the early stages of development`
update README 2019-11-24 08:40:01 +08:00			`- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku) - (probably) first BiliBili stream recording tool.`