# bp.js

> Bulletproof is a HTML5 advanced danmaku (live comment) rendering engine.

Latest version **0.6.0-alpha** (published 2016-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install bp.js
pnpm add bp.js
yarn add bp.js
bun add bp.js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0-alpha |
| Published | 2016-10-30 |
| First published | 2016-10-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5.0 |
| Dependencies | 10 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Maintainers | George Wu |
| Keywords | live comment, danmaku, webgl, html5, render engine |

## Links

- npm: https://www.npmjs.com/package/bp.js
- Repository: https://github.com/hozuki/Bulletproof
- Homepage: https://github.com/hozuki/Bulletproof#readme
- Issues: http://github.com/hozuki/Bulletproof/issues
- npm.io page: https://npm.io/package/bp.js

## Dependencies (10)

- [gulp](https://npm.io/package/gulp.md) ^3.9.0
- [libtess](https://npm.io/package/libtess.md) ^1.2.1
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [browserify](https://npm.io/package/browserify.md) ^12.0.1
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^1.2.2
- [gulp-uglify](https://npm.io/package/gulp-uglify.md) ^1.5.1
- [vinyl-buffer](https://npm.io/package/vinyl-buffer.md) ^1.0.0
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^1.6.0
- [gulp-typescript](https://npm.io/package/gulp-typescript.md) ^2.10.0
- [vinyl-source-stream](https://npm.io/package/vinyl-source-stream.md) ^1.1.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.6.0-alpha (latest) — 2016-10-30

## README

# Bulletproof

[![Travis](https://img.shields.io/travis/hozuki/Bulletproof.svg)](https://travis-ci.org/hozuki/Bulletproof)

**Advanced danmaku render engine based on WebGL and other HTML 5 technologies**

**以 WebGL 和其他 HTML 5 技术为核心的高级弹幕渲染引擎**

**WORK IN PROGRESS**

You can also check out the live demo from <http://hozuki.github.io/Bulletproof>.

## Details

Coming soon...

## Downloading from NPM

```shell
npm install bp.js
```

(Why isn't the package name `bulletproof`? Because that name was registered before this
package publishes to NPM. （ つ Д ｀）)

## Building & Testing

Git, Node.js, NPM and Gulp are required.

```shell
$ git clone https://github.com/hozuki/Bulletproof.git
$ npm install
$ git submodule update --init --recursive
$ cd lib/glantern
$ npm install
$ cd ../../
$ gulp
```

To preview, at least one of modern browsers is required:
- Chrome (50-60 fps)
- NW.js (50-60 fps)
- Electron <sup>Has not been tested, but should work.</sup>
- Firefox (40-60 fps)
- Edge (~24 fps)
- IE 11 (~20 fps)
- Chrome for Android (~16 fps)

Although all these browsers are supported, the order of the list shows the how the
experience will be. Chrome is greatly suggested since the performance on it is the best;
Firefox sometimes is slow; Edge and IE 11 always have serious performance degeneration.

## Features

- [x] High speed rendering
- [x] Cross browser compatibility
- [ ] Web video player interface
  - [x] `<video>`
  - [ ] WebChimera
- [ ] <del>Basic text danmakus</del> (ref: [CommentCoreLibrary](https://github.com/jabbany/CommentCoreLibrary))
  - [ ] <del>Flying *(mode 0)*</del>
  - [ ] <del>Anchored *(mode 1 - mode 6)*</del>
- [ ] <del>Custom text danmakus *(mode 7)*</del> (ref: [BiliBili HTML5 Player](http://www.bilibili.com/html/help.html#p))
- [ ] Scripted danmakus *(mode 8)*
  - [x] `Display`
  - [x] `Functions`
  - [x] `Global`
  - [ ] `Tween`
  - [x] `Player` (almost, `createSound()` and `setMask()` are in progress)
  - [x] `ScriptManager`
  - [x] `Utils`
  - [ ] External library: `Bitmap`
  - [ ] External library: `Storage`
  - [ ] Safety sandbox
- [ ] BiliBili XML parser

## TODO

- [x] `DisplayObject.mask` (`Player.setMask()`)
- [ ] Easing (`Tween` and `ITween`, `$object.motion.easing`)
- [ ] Linking `Player` to [VideoPlayer](http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/fl/video/VideoPlayer.html)
- [ ] `Player.createSound()`
- [ ] `Display.createButton()`
- [ ] Library: `Bitmap`
- [ ] `Display.createCanvas()`

## License

Bulletproof uses [The MIT License](http://mitlicense.org). A copy of it can be found [here](LICENSE.md).

A part of Bulletproof uses modifications based on [`webgl-utils.js`](//github.com/KhronosGroup/WebGL/blob/master/sdk/demos/common/webgl-utils.js). Its license file
can be found [here](docs/license/webgl-utils.txt).

---
_Source: https://npm.io/package/bp.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
