diff --git a/tools/imagecon/README.md b/tools/imagecon/README.md new file mode 100644 index 0000000..1cec480 --- /dev/null +++ b/tools/imagecon/README.md @@ -0,0 +1,48 @@ +imagecon +======== + +Generate amiga data/files from a PNG image file. + +usage +----- + ``` +imagecon: --input [options] +Options: + --output + --colors + --quantize + --output-palette + --override-palette + --verbose +``` + +The following files will be generated: + 1. .bin binary interleave bitplane data + 2. -copper-list.s m68k assembler syntax copper list with no symbols + 3. .pal (optional) palette file listing the palette colors as hex + +options +------- +**--output** +Specify the prefix for the output file set. Extentions will be added to this. Default is the input file name minus the extension. + +**--colors** +Specify the maximum number of colors allowed in the palette. Acceptable values are from 2 to 32. + +**--quantize** +Convert the image to use less colors. + +**--output-palette** +Generate a palette file of the final palette used. Output will be the output file with the ".pal" extension. + +**--override-palette** +Specify a palette file to use that will override the image or quantized palette. Also overrides the --colors option. + +**--verbose** +Display debugging information + +example +------- + ``` + ./imagecon --input full_color.png --output image-data --quantize --colors 32 --palette +``` \ No newline at end of file