ggbgfx-cli v1.0.0

ggbgfx-cli

GGBFX command line interface.
A tool for converting images into the Nintendo Game Boy's graphics format.

Install globally to have access to the ggbgfx command.

npm install -g ggbgfx-cli

Commands

Sprite

Convert PNG into sprite data

ggbgfx sprite

Example:

ggbgfx sprite -b 5 -o sprite_data.c sprite_image.png

Tileset

Convert one or more PNGs into a tileset PNG containing all unique tiles.

ggbgfx tileset

Example

ggbgfx tileset -o city_tiles.png city1.png city2.png

Tilemap

Convert a source PNG and a tileset PNG into a tilemap data.

ggbgfx tilemap

Example

ggbgfx tilemap -b 6 -o city1_tilemap.c -t city_tiles.png city1.png 

Tiledata

Convert a source PNG into tile data

ggbgfx tiledata

Example

ggbgfx tiledata -b 6 -o city_tiles_data.c city_tiles.png

Options

--outfile, -o
Specify output location

--name, -n The name of the C variable definition. Defaults to source name

--bank, -b
Set output bank pragma (e.g. 5)

--offset, -s Offset tilemap numbers by n tiles. Needed if not loading tilemap at initial memory location. (tilemap only)

--raw, -r
Just output raw values, no C variable definitions

--version, -V
Output the version number

--help, -h
Output usage information

See Also

Similar tool rgbgfx for use in Rednex Game Boy Development System.