# LiveAutoRecord

**Repository Path**: xiao-yong/LiveAutoRecord

## Basic Information

- **Project Name**: LiveAutoRecord
- **Description**: 支持多个直播平台的自动录制工具 / NPM 包
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-09-19
- **Last Updated**: 2025-04-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) ![](https://img.shields.io/github/languages/top/WhiteMinds/trial-tower) ![](https://img.shields.io/github/issues/WhiteMinds/LiveAutoRecord) ![](https://img.shields.io/npm/v/@autorecord/manager?label=%40autorecord%2Fmanager) ![](https://img.shields.io/github/v/release/WhiteMinds/LiveAutoRecord?label=client) [![client-build](https://github.com/WhiteMinds/LiveAutoRecord/actions/workflows/release.yml/badge.svg)](https://github.com/WhiteMinds/LiveAutoRecord/actions/workflows/release.yml)

<div align="center">
  <div align="center">
    <img
      src="packages/electron/build/icons/256x256.png"
      alt="Logo"
      width="240"
    />
  </div>
  <h3 align="center">Live Auto Record</h3>
  <p align="center">支持多个直播平台的自动录制工具 / NPM 包</p>
  <div align="center">
    <a href="https://github.com/WhiteMinds/LiveAutoRecord/issues"
      >Bug 反馈</a
    >
    ·
    <a href="https://github.com/WhiteMinds/LiveAutoRecord/issues"
      >功能建议</a
    >
    ·
    <a href="https://github.com/WhiteMinds/LiveAutoRecord/tree/3.x"
      >旧版本</a
    >
  </div>
</div>
<br />

## 关于本项目

这是一个面向多个场景的开源项目

- 普通用户可以直接使用客户端版本来自动录制需要回顾的直播与弹幕
- 专业用户可以使用服务端部署来离线自动录制
- 开发者可以基于插件系统来扩展可用的直播平台，或基于 `@autorecord/manager` 包和已实现的直播平台插件来做一款新的软件

### Built With

<img src="https://img.shields.io/badge/Lerna-9333EA?style=for-the-badge&logo=lerna&logoColor=white" /> <img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white" /> <img src="https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white" /> <img src="https://img.shields.io/badge/Vue.js-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white" /> <img src="https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white" /> <img src="https://img.shields.io/badge/Electron-47848F?style=for-the-badge&logo=electron&logoColor=white" /> <img src="https://img.shields.io/badge/FFmpeg-007808?style=for-the-badge&logo=ffmpeg&logoColor=white" /> <img src="https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express&logoColor=white" />

## 客户端

基于 Electron 整合了 `http-server` 与 `web` 的部分，并对一部分功能做原生化支持。

具有良好的键盘操作支持，预期上可以纯键盘操作。

[进入下载页](https://github.com/WhiteMinds/LiveAutoRecord/releases/)

#### 支持系统

- <img src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" align="top" />
- <img src="https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=apple&logoColor=white" align="top" />
- 由于 linux 用户群体较少，没有尝试在系统此编译，但理论上可以支持。

#### 预览

<h5 align="center">录播任务列表</h5>

<div align="center"><img src="/readme-assets/1.png" width="720" /></div>

<details>
  <summary>点击查看更多 👉</summary>

<h5 align="center">新增录播任务</h5>

<div align="center"><img src="/readme-assets/5.png" width="720" /></div>

<h5 align="center">录播历史</h5>

<div align="center"><img src="/readme-assets/2.png" width="720" /></div>

<!-- #### 录播播放器 -->

<!-- ![](/readme-assets/3.png) -->

<h5 align="center">录播播放器-网页全屏</h5>

<div align="center"><img src="/readme-assets/4.png" width="720" /></div>

<h5 align="center">全局录播配置</h5>

<div align="center"><img src="/readme-assets/6.png" width="720" /></div>

</details>

#### 开发

```bash
# install dependencies
yarn install

# build client dep packages
cd packages/shared && yarn build
cd packages/manager && yarn build

# dev electron
yarn app:dev

# build electron application for production
yarn app:build
```

## 服务端部署

你可以通过下列命令来进行服务端部署：

```shell
# 克隆本仓库
git clone git@github.com:WhiteMinds/LiveAutoRecord.git && cd LiveAutoRecord
# 安装依赖
yarn install
# 编译内部依赖包
cd packages/shared && yarn build
cd packages/manager && yarn build
# 启动服务端
cd packages/http-server && yarn build && yarn start
# 启动前端（也可以将前端 build 后通过 nginx 等方案来访问）
cd packages/web && yarn preview
```

#### 开发

```bash
# install dependencies
yarn install

# build client dep packages
cd packages/shared && yarn build
cd packages/manager && yarn build

# dev server
cd packages/http-server && yarn start:dev
cd packages/web && yarn dev

# deployment for production
cd packages/http-server && yarn build && yarn start # Or start using another method, such as nodemon
cd packages/web && yarn build # Start a web service using a tool such as nginx
```

## 作为 NPM 包引入

核心的包为 [@autorecord/manager](https://www.npmjs.com/package/@autorecord/manager)，该包实现了频道的模型，自动检查的调度等。

此外还要引入直播平台的支持插件或自己实现自定义的平台支持插件，已知的插件有如下：

- [@autorecord/douyu-recorder](https://www.npmjs.com/package/@autorecord/douyu-recorder)
- [@autorecord/bilibili-recorder](https://www.npmjs.com/package/@autorecord/bilibili-recorder)
- [@autorecord/huya-recorder](https://www.npmjs.com/package/@autorecord/huya-recorder)
- [@autorecord/douyin-recorder](https://www.npmjs.com/package/@autorecord/douyin-recorder)

你可以通过 `yarn add @autorecord/manager ` 或其他包管理器来引入它们。

下面是代码实例，另外 http-server 包也是通过 `@autorecord/manager` 和多个插件实现的，也可以作为开发时的参考。

### Example

```typescript
import { createRecorderManager } from '@autorecord/manager'
import { provider as providerForDouYu } from '@autorecord/douyu-recorder'

const manager = createRecorderManager({
  providers: [providerForDouYu],
  // ... other options ...
})
manager.addRecorder({
  providerId: providerForDouYu.id,
  channelId: '74751',
  quality: 'highest',
  streamPriorities: [],
  sourcePriorities: [],
  // ... other options ...
})
manager.startCheckLoop()
```

## 注意事项

软件默认使用 fmp4 格式进行录制，这是综合了抗损坏、实时查看等方面的考虑，如果使用此格式遇到问题，可以手动更换为其他格式。

## Road Map

- 完善弹幕播放器的 UI
- 完善错误处理
- 处理一些代码中的 TODO 项
- 提供文档
- 增加测试
- 简化服务端部署流程
- i18n