Other Languages: 简体中文

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.

We have a live demo here. Feel free to open tickets if this demo test has bugs.

CommentCoreLibrary is licensed under the permissive MIT License.

With yarn: yarn add comment-core-library

With npm: npm install comment-core-library

For Rails, installing with rails-assets is recommended

In Gemfile:

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

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

To use this library with React, please use the react-ccl package instead.

To use this library with Vue, please use the vue-ccl package instead.

• Documentation can be found inside the docs/ folder.
• Experimental modules are in experimental/.
• You may test using test data found in test/.

We encourage any contributions to this project, please read CONTRIBUTING for details on how to contribute to the project.

Also, feel free to have a look at our sister project ABPlayerHTML5 for a reference implementation of a video player with CommentCoreLibrary.