Skip to content

Commit

Permalink
Improve wording of documentation
Browse files Browse the repository at this point in the history
Co-authored-by: Sylvie <[email protected]>
  • Loading branch information
ISSOtm and Rangi42 committed Aug 19, 2024
1 parent 87da4ba commit 7c935bc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
2 changes: 1 addition & 1 deletion contrib/bash_compl/_rgbgfx.bash
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ _rgbgfx_completions() {
[b]="base-tiles:unk"
[c]="colors:unk"
[d]="depth:unk"
[o]="input-tileset:glob-*.2bpp"
[i]="input-tileset:glob-*.2bpp"
[L]="slice:unk"
[N]="nb-tiles:unk"
[n]="nb-palettes:unk"
Expand Down
31 changes: 19 additions & 12 deletions man/rgbgfx.1
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ This changes how tile data is output, and the maximum number of colors per palet
.It Fl i Ar input_tiles , Fl \-input-tileset Ar input_tiles
Read tiles that will be used to convert this image, and that will always be given the first IDs.
.Ar input_tiles
must contain tile data in
.Dq raw
format, as generated through the
must contain 2bpp tile data, as could be previously generated with the
.Fl o
option.
.Pp
Expand All @@ -183,19 +181,28 @@ Otherwise, the image must be able to be generated using
the tiles from
.Ar input_tiles ,
and thus generate different tile data.
The former is more useful if you want to control more precisely the numeric IDs of specific tiles; the latter, if you want several images to share a given set of tiles, such as different levels sharing a single tileset.
.Pp
If more than one color palette is in use, it is also
.Sy strongly
advised to dump it together with the tile data, and to pass it using
.Fl c Cm gbc: Ns Ar input_palette .
Using
.Fl o
with
.Fl i
is useful if you want to precisely control the tile IDs of its tile map.
Using
.Fl i
alone is more useful if you want several images to use a subset of shared tiles.
.Pp
If the image will use more than one color palette, it is
.Em strongly
advised to generate the palette set along with the input tile data, and pass
.Fl c Cm gbc: Ns Ar input_palette
along with
.Fl i input_tiles .
This is because
.Nm
may not pack the palettes the same way that it did when generating
.Ar input_tiles .
may not generate an identical palette set for this image as for its input tileset.
.Pp
See
.Sx EXAMPLES
for an example of how to use this.
for examples of how to use this option.
.It Fl L Ar slice , Fl \-slice Ar slice
Only process a given rectangle of the image.
This is useful for example if the input image is a sheet of some sort, and you want to convert each cel individually.
Expand Down

0 comments on commit 7c935bc

Please sign in to comment.