Lottie-web: Is the JSON format specified anywhere?

Created on 9 Aug 2017  路  15Comments  路  Source: airbnb/lottie-web

I can't find anywhere that explains the format of the JSON file. We would like to potential change it at runtime and I was wondering if it was explained anywhere. I'd like to see how all the shapes/layers/paths/etc are encoded into the current format. (I plan to peek at the source code of bodymovin which may help as well)

Most helpful comment

I've been reverse-engineering the file format, I started from the json schema in here, then fixing things based on actual lottie files and adding looking at lottie-web and rlottie sources.

I've turned it into a Python framework which also generates the documentation for the lottie json in a human-readable format.

It isn't 100% complete yet but it already supports most of the format.

The documentation is here: https://mattia.basaglia.gitlab.io/tgs/group__Lottie.html#details

All 15 comments

Did you check the json docs here?
https://github.com/bodymovin/bodymovin/tree/master/docs/json
it's not complete but it should help.

I did not, thanks! It's something, if not full docs, at least. That helps!

@bodymovin yes,the json docs includes the most of the json means, but some key-value means is excluded from the docs.

@Mrcooder yes, I need to update the doc with newer and missing properties

Please do update. The lack of mapping for some keys (like in properties/valueKeyframed.json) is troublesome. _(And thanks for a nice plugin!)_

Hi @bodymovin , did you get a chance to update the doc?

Hi @jlongster , did you find any doc about the lottie json file?

I would need a correct and complete specification of the file format as well, the json schema seems to differ from how actual files are generated

Just jumping on this, I've been looking for any documentation of the json format for a couple days as well and so far found nothing.

I've been reverse-engineering the file format, I started from the json schema in here, then fixing things based on actual lottie files and adding looking at lottie-web and rlottie sources.

I've turned it into a Python framework which also generates the documentation for the lottie json in a human-readable format.

It isn't 100% complete yet but it already supports most of the format.

The documentation is here: https://mattia.basaglia.gitlab.io/tgs/group__Lottie.html#details

@mbasaglia 404 for the above link.

Doesn't seem like we have official documentation of the format yet. This issue should stay open until such documentation exists.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

DannyK123456 picture DannyK123456  路  3Comments

phantomboogie picture phantomboogie  路  4Comments

jumostudio picture jumostudio  路  3Comments

processprocess picture processprocess  路  3Comments

yannieyeung picture yannieyeung  路  3Comments