Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/3Shain/Comen

📺直播用弹幕栏【原bilichat】
https://github.com/3Shain/Comen

acfun bilibili bilichat livechat obs overlay youtube

Last synced: about 2 months ago
JSON representation

📺直播用弹幕栏【原bilichat】

Host: GitHub
URL: https://github.com/3Shain/Comen
Owner: 3Shain
License: mit
Created: 2019-01-28T04:31:58.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2023-03-08T03:20:28.000Z (almost 2 years ago)
Last Synced: 2024-10-05T09:21:52.217Z (2 months ago)
Topics: acfun, bilibili, bilichat, livechat, obs, overlay, youtube
Language: TypeScript
Homepage: https://comen.app
Size: 4.87 MB
Stars: 908
Watchers: 13
Forks: 83
Open Issues: 18
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-bilibili-extra - Comen - 直播用弹幕栏.![TypeScript](svg/tsnode.svg?raw=true) (直播相关工具 / 直播脚本)

README

# Comen

> 此项目已长期没有维护

[![MIT License](https://img.shields.io/npm/l/isomorphic-danmaku.svg)](https://github.com/3Shain/isomorphic-danmaku/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
原项目【bilichat】请查看[bilichat](https://github.com/3Shain/Comen/tree/bilichat)分支

Comen是一个主要用于在网络直播中向观众展示当前直播间实时评论流的工具。

### 主要特性
* 多平台支持：默认提供了Acfun，Bilibili的接入实现。合理的抽象低耦合设计使得新平台的接入也很容易。
* 高可靠性：不只是一个爱好项目。原项目已运行两年的时间，积累了各种对用户体验和异常处理的优化。
* 兼容Youtube评论栏样式，只需修改URL就能迁移。
* 高度自定义 (计划中,TBD)
* 作为原项目的延续，提供用户几乎无感知的兼容。

### 贡献代码

本项目主要技术栈为前端Angular+后端Nestjs,即完全使用TypeScript(JavaScript)实现。

本项目使用到了nx workspace作为管理代码的工具。本项目是一个monorepo的结构，所以任何本项目开源的部分都能在此仓库找到。

**代码结构**
```
- apps
- core --- 前端项目
- node-backend --- 后端的node(cli)包装
- libs
- backend-core --- 后端的可嵌入式实现
- common --- 常用与扩展代码
- gamma --- 兼容Youtube的评论栏渲染器(Angular组件库)
- isomorphic-danmaku --- 同构弹幕，实现了acfun、bilibili的ws连接
- isomprphic-danmaku-server --- 同构弹幕，服务端only部分
```

**调试运行**
拉取仓库后，首先安装项目依赖
```sh
npm install
```

然后分别打开前端与后端的dev-server
```
nx serve core
nx serve node-backend
```

现在可以对代码进行更改了。任何有关代码更改都会触发自动刷新。

**我想贡献一些新功能/我想修复一些问题**

本项目的主要目标是将一类实时/非实时评论流在任何兼容html5的平台上渲染出来。在抽象设计上，本项目可分成三大部分：评论源(source),过滤器(filter)和渲染器(renderer)

* 我想添加一个新的平台实现

参考 apps/core/src/app/sources 下的文件。你需要实现MessageSource接口，其中connect方法就是返回一个生产Message的可观察对象。

* 我想修改过滤相关的代码

参考 apps/core/src/app/common/filter.ts 。过滤器是通过rxjs的pipe实现的，强烈建议熟练掌握rxjs，或仅在现有的代码上修改。原理上有点类似于后端的middleware，但rxjs的可观察对象概念要复杂一些，涉及到错误处理，subscription和complete的处理。
另外你还可能需要参考各类Message对象的定义(common包的message.ts)。他们只是单纯的数据对象，不涉及到类也没有成员函数。这些类型定义可能并不稳定。Message由source生成，经过filter后最终流向renderer。但并不是所有类型(以type字段区分的类型)都会被renderer处理。filter也有可能在中间对类型对象数据进行转换/变更。

* 我想修改渲染相关的代码

所有渲染相关代码都在libs/gamma包内。