https://github.com/jabbany/CommentCoreLibrary

Javascript Live Comment (Danmaku) Engine Implementation. JS弹幕模块核心，提供从基本骨架到高级弹幕的支持。
https://github.com/jabbany/CommentCoreLibrary

comment comments-streaming danmaku danmu html5 typescript video

Last synced: 9 days ago
JSON representation

Javascript Live Comment (Danmaku) Engine Implementation. JS弹幕模块核心，提供从基本骨架到高级弹幕的支持。

• Host: GitHub
• URL: https://github.com/jabbany/CommentCoreLibrary
• Owner: jabbany
• License: mit
• Created: 2012-03-21T17:35:37.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-10-17T18:14:03.000Z (about 1 year ago)
• Last Synced: 2024-10-29T15:34:53.217Z (10 days ago)
• Topics: comment, comments-streaming, danmaku, danmu, html5, typescript, video
• Language: TypeScript
• Homepage: http://jabbany.github.io/CommentCoreLibrary/demo
• Size: 10.6 MB
• Stars: 1,902
• Watchers: 92
• Forks: 304
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - CommentCoreLibrary
• awesome-acg - CommentCoreLibrary - Javascript Live Comment (Danmaku) Engine Implementation. [English/中文] (Danmaku)
• awesome-danmaku - CommentCoreLibrary - Javascript Live Comment (Danmaku) Engine Implementation. JS弹幕模块核心，提供从基本骨架到高级弹幕的支持。 http://jabbany.github.io/CommentCoreLibrary/demo (Clients / HTML/JavaScript)
• awesome-star-libs - jabbany / CommentCoreLibrary

README

        
# CommentCoreLibrary 弹幕核心通用构件

[![NPM version](https://badge.fury.io/js/comment-core-library.svg)](http://badge.fury.io/js/comment-core-library)

[![Bower version](https://badge.fury.io/bo/comment-core-library.svg)](http://badge.fury.io/bo/comment-core-library)

[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

[![Build Status: Linux](https://travis-ci.org/jabbany/CommentCoreLibrary.svg?branch=master)](https://travis-ci.org/jabbany/CommentCoreLibrary)

[![Coverage Status](https://img.shields.io/coveralls/jabbany/CommentCoreLibrary.svg)](https://coveralls.io/r/jabbany/CommentCoreLibrary?branch=master)

Other Languages: [简体中文](README.zh_CN.md)

The CommentCoreLibrary is a set of Javascript modules that make up the

core controller for comments streaming on top of timed media (video or audio).

It is intended as a catalyst for the development of timed "danmaku" comments

in HTML5.

Developers willing to incorporate similar comment streaming functionalities

inside their own projects (whether web based or not) are encouraged to learn

from and extend from the CommentCoreLibrary.

## Testing

We have a live demo [here](http://jabbany.github.io/CommentCoreLibrary/demo).

Feel free to [open tickets](CONTRIBUTING.md) if this demo test has bugs.

## License

The CommentCoreLibrary is licensed under the permissive MIT License. If you wish

to use this in any project, you can simply include the following line:

    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license

## Installing

With [bower](http://bower.io/):

`bower install comment-core-library`

With [npm](https://www.npmjs.org/):

`npm install comment-core-library`

For Rails, installing with [rails-assets](https://rails-assets.org/) is recommended

In Gemfile:

```ruby

# Add https://rails-assets.org as the new gem source

source 'https://rails-assets.org'

gem 'rails-assets-comment-core-library'

```

## Examples and Documentation

- [Documentation](docs/) can be found inside the `docs/` folder.

- Experimental modules are in `experimental/`.

- You may test using test data found in `test/`.

## Contributing

We encourage any contributions to this project, please read

[CONTRIBUTING](CONTRIBUTING.md) for details on how to contribute to the project.

Also, feel free to have a look at our sister project

[ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5) for a reference

implementation of a video player with CommentCoreLibrary.