Support Aseprite export format (.json) for animations #379

nwessman · 2021-03-10T22:38:46Z

Adds support for importing/exporting animations as json

This adds the functionality of importing and exporting Aseprite formatted .json files.

Import

In the Resources menu there are now the option to Import Animation, which lets you select a .json file and it will import the corresponding spritesheet that is specified in that json import it to the engine with its data set (duration and so forth).

The import searches for the json like this:

import searches 'image' element in .json,
filename as the 'image' spritesheet but in same folder as .json,
finally also searches same folder as .json for same name as .json with suffix from 'image' element
so if 'image'=/animation.png and json=/anim.json, also searches /animation.png and /anim.png

Export

There is also now the option to export an animation as a json in the Aseprite format.

Code coverage

resolve #321

Version: gson 2.8.6

This file is intended to handle importing and exporting of Aseprite JSON files for animations.

This changes the access modifiers of the fields keyframes, name and spritesheet in Animation-class so it can be used in the export process.

This adds the basic structure of Json format aseprite uses.

This reverts commit 083e2c4.

This adds a function that creates the aseprite json as a string representation. it currently only works for the frames object and does not include the meta-data object.

This fixes the broken index when creating the frame objects in aseprite json.

This adds a test for exportAnimation. It prints the constructed json to screen so it can be visualy asserted that it looks like it is supposed too.

This adds so that the meta object is created in the json. The app, version, format, scale and layers are now hardcoded.

Added function AsepriteHandler.importAnimation takes a path to the Aseprite .json file and returns an internal Animation object.

Added a new folder intended to contain test animations that can be used for testing the Aseprite import functionality.

Verifies that the import works as expected when given valid input.

This changes so it is the tests that prints the json not the export function.

Implemented import functionality for Aseprite animations

…bject Fix spritesheetresource object

Added two functions for importing animations. They work much like importspritesheet

Changed imports

Added UI elements to resourcemenu for import

Integration for export. Changed if else statements to switch

GUI integration of import and export

Removes unwanted possible spritesheet paths. Now searches 'image' element in .json data, and same directory as .json for filename of 'image' element and same name as .json with appropriate suffix.

…gine into myA4

Fix Issue/22

Add some unit tests to importAnimation method.

nightm4re94 · 2021-03-16T17:08:55Z

Amazing, thank you! Please allow us some more time to inspect and assess these changes in detail.

Fixes a build error. The error was: ``` /home/gamebuster/Desktop/Modding/LitiEngine/src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java:270: error: cannot infer type arguments for HashMap<K,V> Map<String, Integer> frame = new HashMap<>() {{ ^ reason: cannot use '<>' with anonymous inner classes where K,V are type-variables: K extends Object declared in class HashMap V extends Object declared in class HashMap ```

Gamebuster19901 · 2021-03-16T18:00:38Z

I've made a PR (DD2480-Group-11#30) to address some issues

Update Issue/321

utiliti/src/de/gurkenlabs/utiliti/swing/AssetPanelItem.java

Removed unnecessary catch block. Any exceptions are caught by the overarching catch-block instead.

src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java

Gamebuster19901 · 2021-03-20T04:00:46Z

src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java

+ * @param spritesheetResource the animation object to export
+ * @throws ExportAnimationException if the export fails
+ */
+ public static String exportAnimation(SpritesheetResource spritesheetResource) throws ExportAnimationException {


A sprite sheet can have multiple Animations. This method should be taking an Animation, or another method added should be added specifically for Animation objects.

I agree! Don't confuse Animations (->keyframes) and Spritesheets (-> dimensions).

I've tried to work on this PR myself (https://github.com/Gamebuster19901/litiengine/tree/gson), but stopped as it requires changes to UtiLITI, as there is no way to select an Animation. You can only select a SpriteSheetResource.

As far as I know, AssetPanelItem.origin cannot be an Animation.

IMO I think animations should be considered a resource themselves, because a spritesheet could have multiple animations, and an animation could be played on multiple spritesheets.

I've tried to work on this PR myself (https://github.com/Gamebuster19901/litiengine/tree/gson), but stopped as it requires changes to UtiLITI, as there is no way to select an Animation. You can only select a SpriteSheetResource.

As far as I know, AssetPanelItem.origin cannot be an Animation.

I think I'll make another attempt with this PR soon, since UtiLITI is in this repository now, and that makes development a lot easier.

nightm4re94 · 2021-04-29T10:32:26Z

src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java

+ }};
+ String spritesheetName = spritesheet.getName();
+ Layer[] layers = {new Layer("Layer", 255, "normal")};
+ Meta meta = new Meta("http://www.aseprite.org/",


Please use links.properties for external links. Also, I don't really like the in-line version information here. Maybe make that reusable.

nightm4re94

These are some welcome and important changes, thank you! Sorry for taking our time with this review. I have noticed some issues that need fixing before I can retest - please address the comments.

nightm4re94 · 2021-04-29T10:34:08Z

src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java

+ * @param spritesheetResource the animation object to export
+ * @throws ExportAnimationException if the export fails
+ */
+ public static String exportAnimation(SpritesheetResource spritesheetResource) throws ExportAnimationException {


I agree! Don't confuse Animations (->keyframes) and Spritesheets (-> dimensions).

nightm4re94 · 2021-04-29T10:36:41Z

utiliti/src/de/gurkenlabs/utiliti/components/Editor.java

@@ -77,6 +79,7 @@
 private static final String TEXTUREATLAS_FILE_NAME = "Texture Atlas XML (generic)";

 private static final String IMPORT_DIALOGUE = "import_something";
+ private static final String ANIMATION_FILE_NAME = "Animation file";


This string should also be localizable.

nightm4re94 · 2022-12-15T21:13:12Z

Closing this due to inactivity. Thank you and feel free to resume at a later point :)

Daniel Halvarsson and others added 30 commits March 4, 2021 17:37

Add gson dependency

850ad90

Version: gson 2.8.6

Add new file AsepriteHandler.java

7a0f8f5

This file is intended to handle importing and exporting of Aseprite JSON files for animations.

Fix access modifiers in Animation to support exporting Json

083e2c4

This changes the access modifiers of the fields keyframes, name and spritesheet in Animation-class so it can be used in the export process.

Add object structure for aseprite json

5fc9246

This adds the basic structure of Json format aseprite uses.

Revert "Fix access modifiers in Animation to support exporting Json"

7f06243

This reverts commit 083e2c4.

Add functionality to create json with frames object

7e53123

This adds a function that creates the aseprite json as a string representation. it currently only works for the frames object and does not include the meta-data object.

Fix index of json frames

77b10c4

This fixes the broken index when creating the frame objects in aseprite json.

Add spritesheet for testing

d872f4a

Add tests for exportAnimation

d071aef

This adds a test for exportAnimation. It prints the constructed json to screen so it can be visualy asserted that it looks like it is supposed too.

Add meta object to json in animationExport

c746954

This adds so that the meta object is created in the json. The app, version, format, scale and layers are now hardcoded.

Add closing bracket to aseprite json

1721274

Fix absolute path to spritesheet

0a638d8

Add import functionality for Aseprite animations

8b8a493

Added function AsepriteHandler.importAnimation takes a path to the Aseprite .json file and returns an internal Animation object.

Add test animations used to test Aseprite import

0cc51f5

Added a new folder intended to contain test animations that can be used for testing the Aseprite import functionality.

Add unit test for Aseprite animation import

61ad827

Verifies that the import works as expected when given valid input.

Add javadoc comments to export

3415a7a

Fix test print json

5867e48

This changes so it is the tests that prints the json not the export function.

Add some unit tests to verify the exceptions.

88f1d8a

Fix formatting

e54f445

Remove redundancy

49a7021

Merge branch 'issue/321' into issue/12

e6512f6

Merge pull request #20 from DD2480-Group-11/issue/12

2163073

Implemented import functionality for Aseprite animations

Change export argument from Animation to SpritesheetResource

64c8def

Fix test so it uses SpritesourceResource

77ebd3d

Merge pull request #21 from DD2480-Group-11/fix_spritesheetresource_o…

dc289ed

…bject Fix spritesheetresource object

Editor integration

9c64b2c

Added two functions for importing animations. They work much like importspritesheet

Update Editor.java

cb98f95

Changed imports

Update ResourcesMenu.java

eccad3c

Added UI elements to resourcemenu for import

Add some unit tests to exportAnimation method.

51b9171

Update AssetPanelItem.java

772565a

Integration for export. Changed if else statements to switch

danhalv and others added 15 commits March 10, 2021 15:49

Merge pull request #26 from DD2480-Group-11/issue/15

e3df2aa

GUI integration of import and export

Merge branch 'issue/321' into Yu_assignment4.

0d397b7

Modify spritesheet searching in Aseprite import

692f422

Removes unwanted possible spritesheet paths. Now searches 'image' element in .json data, and same directory as .json for filename of 'image' element and same name as .json with appropriate suffix.

Remove unused method

8fb5d37

Remove unused imports

4bff7ab

Merge branch 'issue/321' of https://github.com/DD2480-Group-11/litien…

e55c34d

…gine into myA4

Add some unit tests for exportAnimation method.

e359ce3

Add some unit tests to importAnimation method.

fc0f4c1

Refactor the exportAnimationTest.

98affeb

Delete the faulty test.

a94824e

Merge pull request #28 from DD2480-Group-11/issue/22

20574be

Fix Issue/22

Resolve merge conflict.

28e0bf5

Merge pull request #29 from DD2480-Group-11/issue/27

8d867ed

Add some unit tests to importAnimation method.

Fix formatting

ec12f2f

Fix formatting

d1cc4e6

Gamebuster19901 added 4 commits March 16, 2021 13:26

Remove unused imports

ce1269b

Subclass IOException not Error

03ad6ac

Remove unused imports

7d657a2

Merge pull request #30 from Gamebuster19901/issue/321

3144975

Update Issue/321

Gamebuster19901 suggested changes Mar 16, 2021

View reviewed changes

utiliti/src/de/gurkenlabs/utiliti/swing/AssetPanelItem.java Outdated Show resolved Hide resolved

Update AssetPanelItem.java

f06ad52

Removed unnecessary catch block. Any exceptions are caught by the overarching catch-block instead.

Gamebuster19901 suggested changes Mar 17, 2021

View reviewed changes

src/de/gurkenlabs/litiengine/graphics/animation/AsepriteHandler.java Show resolved Hide resolved

Gamebuster19901 suggested changes Mar 20, 2021

View reviewed changes

nightm4re94 reviewed Apr 29, 2021

View reviewed changes

nightm4re94 requested changes Apr 29, 2021

View reviewed changes

nightm4re94 closed this Dec 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Aseprite export format (.json) for animations #379

Support Aseprite export format (.json) for animations #379

nwessman commented Mar 10, 2021

nightm4re94 commented Mar 16, 2021

Gamebuster19901 commented Mar 16, 2021

Gamebuster19901 Mar 20, 2021 •

edited

nightm4re94 Apr 29, 2021

Gamebuster19901 Apr 29, 2021

Gamebuster19901 Apr 29, 2021

Gamebuster19901 Dec 8, 2022

nightm4re94 Apr 29, 2021

nightm4re94 left a comment

nightm4re94 Apr 29, 2021

nightm4re94 Apr 29, 2021

nightm4re94 commented Dec 15, 2022

Support Aseprite export format (.json) for animations #379

Support Aseprite export format (.json) for animations #379

Conversation

nwessman commented Mar 10, 2021

Adds support for importing/exporting animations as json

Import

Export

Code coverage

nightm4re94 commented Mar 16, 2021

Gamebuster19901 commented Mar 16, 2021

Gamebuster19901 Mar 20, 2021 • edited

Choose a reason for hiding this comment

nightm4re94 Apr 29, 2021

Choose a reason for hiding this comment

Gamebuster19901 Apr 29, 2021

Choose a reason for hiding this comment

Gamebuster19901 Apr 29, 2021

Choose a reason for hiding this comment

Gamebuster19901 Dec 8, 2022

Choose a reason for hiding this comment

nightm4re94 Apr 29, 2021

Choose a reason for hiding this comment

nightm4re94 left a comment

Choose a reason for hiding this comment

nightm4re94 Apr 29, 2021

Choose a reason for hiding this comment

nightm4re94 Apr 29, 2021

Choose a reason for hiding this comment

nightm4re94 commented Dec 15, 2022

Gamebuster19901 Mar 20, 2021 •

edited