Skip to content
Snippets Groups Projects
Verified Commit c9e958dd authored by Louis's avatar Louis :fire:
Browse files

Add 'swap' command to docs

parent 0cf658af
No related branches found
No related tags found
No related merge requests found
Pipeline #681 failed with stages
in 44 seconds
...@@ -16,6 +16,7 @@ ...@@ -16,6 +16,7 @@
* [split](commands/split.md) * [split](commands/split.md)
* [palette](commands/palette.md) * [palette](commands/palette.md)
* [remap](commands/remap.md) * [remap](commands/remap.md)
* [swap](commands/swap.md)
* [pipeline](commands/pipeline.md) * [pipeline](commands/pipeline.md)
### Pipelines ### Pipelines
......
...@@ -19,6 +19,11 @@ Options: ...@@ -19,6 +19,11 @@ Options:
-V, --version Print version -V, --version Print version
``` ```
### Palette Swapping
This command can also generate a template for use with the Swap command by specifying `--format columns`. The output will be a PNG
formatted image with a width of `2`, where each row is a unique colour found in the input image.
## Example ## Example
![](/images/Palette.png) ![](/images/Palette.png)
\ No newline at end of file
# Command: Palette Swap
Use a given mapping of colours to alter the input image. The palette image must contain 2 columns, and any colour in the
input image will be checked against the first column of the palette, and if found will be replaced with the corresponding colour in the second column.
## Usage
```text
Usage: crunch swap --palette <PALETTE> <INPUT> <OUTPUT>
Arguments:
<INPUT> The path to the image file
<OUTPUT> The path to write the recoloured image
<PALETTE> The path to the palette image
Options:
-p, --palette <PALETTE> The path to the palette file containing the output colours
-h, --help Print help
-V, --version Print version
```
## Example
![](/images/Swap.png)
\ No newline at end of file
docs/images/Swap.png

14.5 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment