Modify image metadata with czutil

[Danar435]

When replacing an image, czutil updates the dimensions in the metadata to match the dimensions of the new image, but doesn't update the crop and bounds. I think that would rarely be the case when the dimensions change, so I suggest to either update them by default or when a flag is set.

Sometimes the dimensions in the original image's metadata don't match with the crop/bounds, in that case I think it would be best to avoid replacing them, or give a warning, as they might require some manual work (for example with characters and overlays).

It would also be nice to specify x/y coordinates when replacing images or even specify cz type without requiring a source file.

[G2-Games]

Are the x/y coordinates what I'm calling the "offset"? The bytes that sometimes occur at 0x1C and 0x1E, that is.

[G2-Games]

Also, using czutil encode should allow you to specify the type without requiring a source file, only an input PNG.

[G2-Games]

I have added these options, they will be in the next release.

  -n, --no-auto-bounds        Setting this flag turns off the automatic extended header modification
  -c, --crop <CROP>           Set the extended header crop (ex. 1280x720)
  -b, --bounds <BOUNDS>       Set the extended header bounds (ex. 1280x720)

https://github.com/G2-Games/lbee-utils/releases/tag/utils-0.2.1-a7

[Danar435]

Are the x/y coordinates what I'm calling the "offset"? The bytes that sometimes occur at 0x1C and 0x1E, that is.

Right, offset is the correct word for it 😅 also, I believe that they occur at 0x10 and 0x12 regardless of the cz type or header.

czutil encode should allow you to specify the type without requiring a source file

I didn't realize that an encode function exists already haha.

[Danar435]

I just tried the updated tool and they work great! One small thing though, there are now two -b options, namely 'batch' and 'bounds', and the tool defaults to 'batch'.

[G2-Games]

Oops, you're right. I think I'll just disable the short notation for the bounds option.

[G2-Games]

Here are the new sets of options for the CLI, please let me know if this seems good to you! They are included in the latest alpha release:

https://github.com/G2-Games/lbee-utils/releases/tag/utils-0.2.1-a8

+$ czutil replace --help
Replace an existing CZ file's image data

Usage: czutil replace [OPTIONS] <CZ FILE> <IMAGE> <PATH>

Arguments:
  <CZ FILE>  Original input CZ file of any type
  <IMAGE>    Image to use as the replacement
  <PATH>     Output CZ file location

Options:
  -b, --batch                 Replace a whole folder, and output to another folder, using a folder of replacements
  -v, --version <CZ VERSION>  Output CZ file version
  -d, --depth <BIT DEPTH>     Output CZ file bit depth
      --no-clear-palette      Do not clear and regenerate the palette, which causes issues with masks
      --no-auto-bounds        Do not automatically change crop and bounds metadata
      --crop <CROP>           Set the extended header crop (ex. 1280x720)
      --bounds <BOUNDS>       Set the extended header bounds (ex. 1280x720)
  -o, --offset <OFFSET>       Set the extended header offset (ex. 82x73)
  -h, --help                  Print help

+$ czutil encode --help
Encode a PNG file to a CZ

Usage: czutil encode [OPTIONS] <INPUT> <OUTPUT>

Arguments:
  <INPUT>   Input image to encode
  <OUTPUT>  Output CZ file location

Options:
  -v, --version <CZ VERSION>  Output CZ file version
  -d, --depth <CZ BIT DEPTH>  Output CZ file bit depth
      --crop <CROP>           Set the extended header crop (ex. 1280x720)
      --bounds <BOUNDS>       Set the extended header bounds (ex. 1280x720)
  -o, --offset <OFFSET>       Set the extended header offset (ex. 82x73)
  -h, --help                  Print help

[Danar435]

The command/description for the offset might be a bit confusing, because num x num is often associated with sizing and not positioning. You can probably have it be comma separated, like coordinates: num, num.

Though what I would prefer would be to separate the command, as in --x-offset num and same for y. That might be more convenient, because sometimes you may only want to change one of the axes. On that note, it would be nice if it could also do simple arithmetic operations, such as --y-offset +48. Personally I had to move a bunch of images down and they all had different offsets...

[G2-Games]

Ah, understood. I can modify that easily!

[G2-Games]

I will document it these new features as well, but feel free to add to any documentation such as the main README.md. Documenting things is the most time consuming part for me, and when things change documentation changes and it takes time, so contributions are welcome.