From 6308dd914763e454f0fe9a57a765825844885343 Mon Sep 17 00:00:00 2001 From: "Juan J. Martinez" Date: Tue, 15 Jun 2021 21:36:59 +0100 Subject: Documented png2sprites.py --- docs/images/player.png | Bin 0 -> 9809 bytes docs/tools.md | 27 ++++++++++++++++++++++++++- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/images/player.png (limited to 'docs') diff --git a/docs/images/player.png b/docs/images/player.png new file mode 100644 index 0000000..8ea64b1 Binary files /dev/null and b/docs/images/player.png differ diff --git a/docs/tools.md b/docs/tools.md index ec8b56f..d94de8b 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -14,7 +14,32 @@ TODO ### png2sprites.py -The png2sprites.py tool converts an image that is a multiple of 16x16 into multiple sprites. Sprites are also separated by colour values. Dark grey (#1c1c1c) is assigned to transparent in the MSX colour index. +The tool converts an image that is a multiple of 16x16 into a sprite (or +sprites), to be used by [ubox's sprite functions](ubox-lib-ref.html#sprite-functions). + +The result is 1 bit per pixel data without colour information. The colour will +be provided as part of the `attr` field in the `sprite_attr` struct when +calling [ubox_set_sprite_attr](ubox-lib-ref.html#ubox_set_sprite_attr). + +The tool interprets dark grey (RGB: 28, 28, 28) as transparent in the MSX +palette, and any other colour will be used as visible the monochrome data. If +the image has more than one colour, it will be used to identify different +sprites. + +For example: + +![Example sprite with 2 colours per frame](images/player.png) + +Will be translated into 6 sprites: 3 frames (16x16) with 2 sprites per frame, +corresponding to the sprite defined by the green colour and the sprite +defined by the white colour. + +Usage following the example: +``` +png2sprites.py -i player_sprite player.png > player.h +``` + +Use `-h` for the full list of options. ### map.py -- cgit v1.2.3