Mercurial > malikania
view doc/src/specs/sprite.md @ 196:5b0f7ffab962
doc: initial html support
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 20 Nov 2018 12:14:00 +0100 |
parents | docs/specs/sprite.md@3107ce017c3a |
children | 268b66d72ec0 |
line wrap: on
line source
# Sprite A sprite is an object that splits an image into several cells. It is primarily designed to combine multiple related images into one for better performance and easier usage. Sprites are mostly used as character design, some GUI elements, map tilesets and other data that require lots of related images. Sprites can be created natively in C++, Javascript or using the resource loader with an appropriate JSON description. ## JSON specification ### Synopsis ```json { "image": "image identifier", "cell": [ 0, 0 ], "margin": [ 0, 0 ], "space": [ 0, 0 ], "size": [ 50, 50 ] } ``` ### Properties - image: unique identifier to an image, - cell: size of sprite cells, - margin: top/left and bottom/right margins (Optional: default none), - space: space between each cell horizontally/vertically (Optional: default none), - size: override image size (Optional: default automatic).