From d4ab530d7008f6a32ac65591081e7b8dd0ddfb28 Mon Sep 17 00:00:00 2001 From: Brad Simpson Date: Fri, 11 Aug 2023 15:17:16 -0600 Subject: [PATCH 1/3] Readme and example improvements --- README.md | 4 ++-- example.json | 44 ++++++++++++++++++++++++++++++-------------- 2 files changed, 32 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c560247..433919e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Uses v5.7.6 of Lottie. ## Adapt Authoring Tool -Change the file ending of your json from `.json` to `.svgz` for use in the AAT image picker. +To use in the AAT image picker, change the file ending of your JSON file from `.json` to `.svgz`. ## Settings Overview @@ -17,7 +17,7 @@ The attributes listed below are used in *course.json* to configure **Adapt Graph >**\_isEnabled** (String): Defaults to `true`. ->**\_fileExtension** (String): The image file extension of the json file. Acceptable values are `svgz` and `bmp`. Defaults to `svgz`. +>**\_fileExtension** (String): The file extension of the JSON file that is exported from Adobe After Effects. Acceptable values are `svgz` and `json`. Defaults to `svgz`. >**\_loops** (Number): Controls how many times the animation should loop when inview. To set an infinite loop, use a value of `-1`. Defaults to `0` (don't loop). diff --git a/example.json b/example.json index 4f6d8a0..9a21545 100644 --- a/example.json +++ b/example.json @@ -1,15 +1,31 @@ - // course.json - { - "_graphicLottie": { - "_isEnabled": true, - "_fileExtension": "svgz", - "_loops": -1, - "_autoPlay": true, - "_onScreenPercentInviewVertical": 1, - "_playFirstViewOnly": true, - "_offScreenPause": true, - "_offScreenRewind": true, - "_showPauseControl": false, - "_onPauseRewind": false - } +// course.json +"_graphicLottie": { + "_isEnabled": true, + "_fileExtension": "svgz", + "_loops": -1, + "_autoPlay": true, + "_onScreenPercentInviewVertical": 1, + "_playFirstViewOnly": true, + "_offScreenPause": true, + "_offScreenRewind": true, + "_showPauseControl": false, + "_onPauseRewind": false +} + +// components.json - Example using a Lottie animation in a Graphic component +{ + "_id": "c-05", + "_parentId": "b-05", + "_type": "component", + "_component": "graphic", + "_classes": "", + "_layout": "left", + "title": "Graphic component", + "displayTitle": "", + "body": "", + "instruction": "", + "_graphic": { + "large": "course/en/images/graphic.svgz", + "small": "course/en/images/graphic.svgz" } +} From 1f3a45401c546e12e3fc854fd42c562ec248e5b4 Mon Sep 17 00:00:00 2001 From: Brad Simpson Date: Fri, 11 Aug 2023 15:22:05 -0600 Subject: [PATCH 2/3] Clarify AAT requirements --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 433919e..bf56171 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ Uses v5.7.6 of Lottie. ## Adapt Authoring Tool -To use in the AAT image picker, change the file ending of your JSON file from `.json` to `.svgz`. +To use in the AAT image picker: +- Change the file ending of your JSON file from `.json` to `.svgz` +- In *course.json*, change `_graphicLottie._fileExtension` to `svgz` ## Settings Overview From 6c4253c4fd265099060d69301746256da5676d18 Mon Sep 17 00:00:00 2001 From: Brad Simpson Date: Fri, 11 Aug 2023 15:26:07 -0600 Subject: [PATCH 3/3] Minor wording change --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf56171..33c30d2 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Uses v5.7.6 of Lottie. ## Adapt Authoring Tool -To use in the AAT image picker: +To use with the AAT's image picker: - Change the file ending of your JSON file from `.json` to `.svgz` -- In *course.json*, change `_graphicLottie._fileExtension` to `svgz` +- In *course.json*, ensure `_graphicLottie._fileExtension` is set to `svgz` ## Settings Overview