Skip to content
Snippets Groups Projects
README.md 1.42 KiB
Newer Older
Louis's avatar
Louis committed
# Crunch

Command line image manipulation, set up a pipeline once and run it against all of your assets

## Usage

Louis's avatar
Louis committed
Crunch takes an image and applies a transformation to it. But what if you want to do **two** transformations?
Or transform more than one image at a time?

Pipelines!
Louis's avatar
Louis committed

Louis's avatar
Louis committed
The main value of Crunch is reproducible image processing, as defined by a [pipeline toml]() file.
Louis's avatar
Louis committed

Louis's avatar
Louis committed
Basic CLI usage:
Louis's avatar
Louis committed

Louis's avatar
Louis committed
```shell
USAGE:
    crunch [OPTIONS] <IN_PATH> <OUT_PATH> <SUBCOMMAND>
Louis's avatar
Louis committed

Louis's avatar
Louis committed
ARGS:
    <IN_PATH>     The path to the spritesheet file
    <OUT_PATH>    The path to the output file
Louis's avatar
Louis committed

Louis's avatar
Louis committed
OPTIONS:
    -f, --format <FORMAT>    Force Crunch to read the input file as a specific format [possible
                             values: png, jpg, gif, ico, tga, tiff, bmp]
    -h, --help               Print help information
    -V, --version            Print version information
Louis's avatar
Louis committed

Louis's avatar
Louis committed
SUBCOMMANDS:
    extrude     Take each tile in an image and expand its borders by a given amount
    flip        Flip an image along one or both axis
    help        Print this message or the help of the given subcommand(s)
    palette     Create a palette file containing every distinct colour from the input image
    pipeline    Execute a pipeline file to run multiple commands on one or more images
    remap       Convert the colour space of an input image to the given palette
    rotate      Apply a clockwise rotation to the image
    scale       Make an image larger or smaller
Louis's avatar
Louis committed

Louis's avatar
Louis committed
```