Skip to content

Commit

Permalink
doc: update help output
Browse files Browse the repository at this point in the history
  • Loading branch information
fgardt committed Mar 27, 2024
1 parent 51400e9 commit 4de7ebe
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Arguments:
Options:
-l, --lua
Enable lua output generation
-p, --prefix <PREFIX>
Prefix to add to the output file name [default: ]
-r, --recursive
Recursive search for images. Each folder will be a separate sprite sheet
-t, --tile-resolution <TILE_RESOLUTION>
Expand All @@ -47,6 +49,11 @@ Options:
Set when this is considered a high resolution texture
--no-crop
Set when the sprites should not be cropped
-s, --scale <SCALE>
Set a scaling factor to rescale the used sprites by.
Values < 1.0 will shrink the sprites. Values > 1.0 will enlarge them. [default: 1]
--scale-filter <SCALE_FILTER>
The scaling filter to use when scaling sprites [default: catmull-rom] [possible values: nearest, triangle, catmull-rom, gaussian, lanczos3]
```

### Icon
Expand All @@ -57,16 +64,15 @@ Generate a mipmap icon from a folder of images
The individual images are used as the respective mip levels and combined into a single image
Usage: spritter icon <SOURCE> <OUTPUT>
Usage: spritter icon [OPTIONS] <SOURCE> <OUTPUT>
Arguments:
<SOURCE>
Folder containing the individual sprites
<OUTPUT>
Output folder
<SOURCE> Folder containing the individual sprites
<OUTPUT> Output folder
Options:
-l, --lua
Enable lua output generation
-p, --prefix <PREFIX>
Prefix to add to the output file name
```

0 comments on commit 4de7ebe

Please sign in to comment.