One question that popped up in my head was whether we want to generate "verbose" .sprite files that include comments about the format or just plain definition data.

So either the output looks like this:

# format version
version 0

# image file references, relative to this file
# imagefile <image_id> <filename>
image 0 houses.png
image 1 house_shadows.png

# layer definitions, from bottom to top (later defined layers overdraw earlier layers)
# all layers will be drawn.
# layer <id> mode=off  position=<default|roof|shadow>
layer 0 mode=off position=default
layer 1 mode=off position=shadow

# frame definitions for an angle
#
# assign frames to their layers (their angle is implied by the last angle definition).
# *pos, *size and *hotspot is within the source image.
# all the hotspots of the frames will be drawn at the same pixel (requested by renderer)
# so that the alignment/movement of the frames is done solely by hotspots.
# frame <layer_id> <image_id> <xpos> <ypos> <xsize> <ysize> <xhotspot> <yhotspot>
angle 0
frame 0 0 0 0 50 50 25 25
frame 1 1 0 0 30 50 TODOOOOOOOOO

or like this:

version 0
image 0 houses.png
image 1 house_shadows.png
layer 0 mode=off position=default
layer 1 mode=off position=shadow

angle 0
frame 0 0 0 0 50 50 25 25
frame 1 1 0 0 30 50 TODOOOOOOOOO

The latter one is obviously more space efficient, but the size of comments is probably negligible too.

@brisvag Any news on this one?

@simonsan No. Unfortunately, I had no time to work on it, and probably won't for a while :/

One question that popped up in my head was whether we want to generate "verbose" .sprite files that include comments about the format or just plain definition data.

I think we should generate the plain definition data, and maybe add a comment as header in every file which aids in googling the format or we provide a link to the documentation (which might outdate, so I'd favor the former one. for example # openage sprite definition for $entityname or something like that)

I closed up all the outdated conversations in this thread.

I just rebased on the current master and pushed the latest changes: they are based on the current signature of DataDefinition at #1151.

One question that popped up in my head was whether we want to generate "verbose" .sprite files that include comments about the format or just plain definition data.

There could be a parameter for this in the dump method. In that case, I guess we should implement this for everything that inherits from DataDefinition, right?

A few minor things need fixing/improvement. Then we're good to go :)

I should have solved all the issues. Let me know!

Great :) Now you only have to fix the CI complains that are still there.

Rebased to #1151.

merged into #1151 :)