Sprite Utils: Difference between revisions

Help

Revision as of 14:29, 15 August 2024

Sprite Utils is a Java application used to manage sprite positions in images.

Sprite positions are saved in spritesheet.csv

Syntax: java -jar sprite-utils.jar command --option1 valueOfOption1 --option2 valueOfOption2 ... --optionN valueOfOptionN

Options


Option name	Description	Mandatory	Default value
--dir	absolute path to the directory with images, which includes sprites	Yes for Draw command	N/A
--rectangle-color	border color of rectangles - comma separated list of RGB (bytes)	No	0,255,0
--sprite-sheet-path	absolute path to the CSV file with the sprite sheet positions	Yes for Draw command	N/A
--row

Commands

Command: draw

Rectangles are drawn around the sprites and each sprite is labeled with its number. in the image

Example:

java -jar /rv/data/desktop/code/code.nanoboot.org/nanoboot/sprite-utils/target/sprite-utils-0.0.0-SNAPSHOT-jar-with-dependencies.jar \
draw \
--dir /rv/data/desktop/code/code.nanoboot.org/nanoboot/open-eggbert-legacy-assets/speedy_eggbert_1/IMAGE08  \
--rectangle-color 255,0,0  \
--sprite-sheet-path /rv/data/desktop/code/code.nanoboot.org/nanoboot/open-eggbert/assets/default-spritesheets/speedy_blupi_I.spritesheet.csv  \
--row 5 \
--file-name OBJECT.BLP \
--double-sized-number true

@@ Line 16: / Line 16: @@
 |Yes for Draw command
 |N/A
+|-
+|'''--rectangle-color'''
+|border color of rectangles - comma separated list of RGB (bytes)
+|No
+|0,255,0
+|-
+|'''--sprite-sheet-path'''
+|absolute path to the CSV file with the sprite sheet positions
+|Yes for Draw command
+|N/A
+|-
+| --row
+|
+|
+|
+|-
+|
+|
+|
+|
 |-
 |
@@ Line 28: / Line 48: @@
 |}
-'''--rectangle-color''' color of the border of the rectangles - comma separated list of byte representations the red, green and blue colors
-'''--sprite-sheet-path''' absolute path to the CSV file with the sprite sheet positions
---row
 == Commands ==