https://github.com/jmconde/bm-player

A player for lottie-web's after effects plugin animations
https://github.com/jmconde/bm-player

after-effects animations bodymovin es6 javascript lottie-web player rollup-js

Last synced: about 2 months ago
JSON representation

A player for lottie-web's after effects plugin animations

• Host: GitHub
• URL: https://github.com/jmconde/bm-player
• Owner: jmconde
• License: mit
• Created: 2018-02-24T08:48:21.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-01T23:14:50.000Z (about 2 years ago)
• Last Synced: 2023-08-13T09:22:10.286Z (over 1 year ago)
• Topics: after-effects, animations, bodymovin, es6, javascript, lottie-web, player, rollup-js
• Language: JavaScript
• Size: 3.3 MB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BODYMOVIN PLAYER v0.1.2

This project allows to chain After Effects lottie-web (bodymovin) plugin animations like a movie's storyboard.

## Install module

```

npm i bm-player --save

```

## Demo

See index.html in ```dist/demo``` directory.

## Documentation

```

import BMPlayer from 'bm-player';

-or-

var BMPlayer = require('bm-player');

-or-

window.BMPlayer

```

```

new BMPlayer();

```

### Player Options

```javascript

/**

@param {Array}    scenes    required

@param {String}   container      required

@param {Boolean|Number}  autoplay   default: false if number set it is a delay in seconds

@param {Boolean|Number}  loop

@param {Player}   chain

**/

```

### Scene Options

```javascript

/**

@param {String}   id        required

@param {String}   path      required

@param {Boolean|Number}  loop

@param {Number}   duration

@param {Boolean}  reverse

@param {Number}   speed

**/

```

### Public Methods

* play(```undefined``` | index | id)

* stop()

* pause()

* next()

### Events

* start

* complete

* scene

* sceneComplete

* loopComplete

## Contributing

```javascript

git clone [email protected]:jmconde/bm-player.git

npm i -g rollup

npm i -g browser-sync

npm install

```

Make your changes and create a pull request! =)