BililiveRecorder/README.md

# BiliBili Stream Recorder

[![Build status](https://ci.appveyor.com/api/projects/status/1n4822yitgtu7ht7?svg=true)](https://ci.appveyor.com/project/Genteure/bililiverecorder)
[![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)
[![Issues are "help wanted"](https://img.shields.io/github/issues/Bililive/BililiveRecorder/help%20wanted.svg)](https://github.com/Bililive/BililiveRecorder/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![Pull Request Welcome](https://img.shields.io/badge/Pull%20request-welcome-brightgreen.svg)](#)
[![license](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)

[简体中文 | 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.

[![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)

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
- Reset timestamp to start from 0
- Writes duration info automatically when recoding session ends.
- Start recording when stream starts
- Record multiple stream at same time
- Pure C#, no native dependency like ffmpeg
- Open source!

## Develop & Getting Started

**Visual Studio 2017 / 2019 with .NET Core** and **PowerShell** is required.

Some file are generated by [PreComplie Script](./CI/patch_buildinfo.ps1). Build project to clear errors shown by Visual Studio.

Project | Type | Note
:---:|:---:|:---
BililiveRecorder.WPF | .NET Framework 4.6.2
BililiveRecorder.Core | .NET Standard 2.0
BililiveRecorder.FlvProcessor | .NET Standard 2.0
BililiveRecorder.Server | .NET Core 2.0 | TODO

## 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)
- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku) - (probably) first BiliBili stream recording tool.
update README [skip ci] 2018-03-31 17:05:16 +08:00			`# BiliBili Stream Recorder`
Add Appveyor status badge [skip ci] 2018-03-25 15:23:48 +08:00
			`[![Build status](https://ci.appveyor.com/api/projects/status/1n4822yitgtu7ht7?svg=true)](https://ci.appveyor.com/project/Genteure/bililiverecorder)`
update README [skip ci] 2018-04-17 12:26:12 +08:00			`[![Version](https://img.shields.io/github/tag/Bililive/BililiveRecorder.svg?label=Version)](#)`
			`[![Issues are "help wanted"](https://img.shields.io/github/issues/Bililive/BililiveRecorder/help%20wanted.svg)](https://github.com/Bililive/BililiveRecorder/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)`
			`[![Pull Request Welcome](https://img.shields.io/badge/Pull%20request-welcome-brightgreen.svg)](#)`
			`[![license](https://img.shields.io/github/license/Bililive/BililiveRecorder.svg)](#)`
init 2018-03-12 18:57:20 +08:00
update README [skip ci] 2018-03-31 17:05:16 +08:00			`[简体中文 \| 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			`[![Crowdin](https://badges.crowdin.net/bililiverecorder/localized.svg)](https://crowdin.com/project/bililiverecorder)`

			`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 2019-11-24 08:40:01 +08:00			`- Reset timestamp to start from 0`
			`- Writes duration info automatically when recoding session ends.`
update README [skip ci] 2018-03-31 17:05:16 +08:00			`- Start recording when stream starts`
			`- Record multiple stream at same time`
update README 2019-11-24 08:40:01 +08:00			`- Pure C#, no native dependency like ffmpeg`
update README [skip ci] 2018-03-31 17:05:16 +08:00			`- Open source!`

			`## Develop & Getting Started`

Update README [no ci] 2020-02-23 16:54:55 +08:00			`Visual Studio 2017 / 2019 with .NET Core and PowerShell is required.`
update README [skip ci] 2018-03-31 17:05:16 +08:00
			`Some file are generated by [PreComplie Script](./CI/patch_buildinfo.ps1). Build project to clear errors shown by Visual Studio.`

			`Project \| Type \| Note`
			`:---:\|:---:\|:---`
			`BililiveRecorder.WPF \| .NET Framework 4.6.2`
			`BililiveRecorder.Core \| .NET Standard 2.0`
			`BililiveRecorder.FlvProcessor \| .NET Standard 2.0`
			`BililiveRecorder.Server \| .NET Core 2.0 \| TODO`

			`## 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)`
			`- [coreyauger/flv-streamer-2-file](https://github.com/coreyauger/flv-streamer-2-file)`
			`- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku) - (probably) first BiliBili stream recording tool.`