lottiefy

    0.0.4 • Public • Published

    lottiefy

    npm

    A toolkit to customize Lottie renderer. Demo here: https://pd4d10.github.io/lottiefy/

    Motivation

    Lottie is a solution to transform Adobe After Effects animations directly to code. It already has web, Android and iOS renderers. But Sometimes we need more control. For example, developers may want to render Lottie to other engines, like Cocos2d-x and PixiJS. With lottiefy, you can customize your own renderer in these cases.

    Notice: It is 0.x currently, and may have breaking changes in future. Please submit an issue if something went wrong.

    Use cases

    Installation

    Install via NPM:

    npm install --save lottiefy

    Or just use UMD bundle via script tag:

    <script src="https://unpkg.com/lottiefy/dist/lottiefy.min.js"></script>

    Usage

    import { LottieRenderer } from 'lottiefy'
     
    const renderer = new LottieRenderer({
      animationData: {}, // JSON data exported by Bodymovin
      containerId: '', // The id of container to render
      actions: {
        createPrecomp(id, payload) {
          // Specify how to create a precomp
          // ...
        },
        createImage(id, payload) {
          // Specify how to create an image
          // ...
        },
        // ...
     
        // List of all actions:
        // https://github.com/pd4d10/lottiefy/blob/master/src/types.ts#L53
        // Notice that all actions should be specified to make it works correctly
      },
     
      // Some engines like Cocos2d-x have opposite Y coordinate with Adobe After effects
      // Set reverseY to true in these cases, default is false
      reverseY: false,
     
      // Set animation speed
      speed: 1,
    })
     
    // Call generateAnimations to run all actions
    renderer.generateAnimations()

    Roadmap

    • Precomp
    • Image
    • Shape
    • Effect
    • ...

    License

    MIT

    Keywords

    none

    Install

    npm i lottiefy

    DownloadsWeekly Downloads

    1

    Version

    0.0.4

    License

    MIT

    Unpacked Size

    50.4 kB

    Total Files

    14

    Last publish

    Collaborators

    • pd4d10