Is the JSON format specified anywhere?

[jlongster]

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)

[bodymovin]

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

[jlongster]

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

[LeeYunhang]

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

[bodymovin]

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

[Phrogz]

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

[zhengs]

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

[tigaliang]

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

[mbasaglia]

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

[behdad]

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.

[mbasaglia]

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]

Updated link: http://mattia.basaglia.gitlab.io/python-lottie/group__Lottie.html#lottie_json

[tigaliang]

@mbasaglia 404 for the above link.

[mbasaglia]

Ah yeah I had to move it again https://mattbas.gitlab.io/python-lottie/group__Lottie.html#lottie_json

[zero-enthusiasm]

Found it again: https://mattbas.gitlab.io/python-lottie/group__Lottie.html#details

[frmsaul]

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

[marcusstenbeck]

There are a few resources available online now:

TypeScript def: https://github.com/marcusstenbeck/lottie-types
Bodymovin JSON docs: https://github.com/bodymovin/bodymovin/tree/master/docs/json
python-lottie docs: https://mattbas.gitlab.io/python-lottie/group__Lottie.html#details
LottieFiles lottie-docs: https://github.com/LottieFiles/lottie-docs
Lottie Animation Community repos: https://github.com/lottie-animation-community/

The most easily digestible is the LottieFiles lottie-docs project, which is by the same person who did the python-lottie package (@mbasaglia).