# flow-texpack

`flow-texpack` is a program that will allow you to generate texture atlas from
input images (BMP, HDR, JPG, PNG, TGA, TIFF, WEBP). The application generates
both texture atlas and descriptions file that can be read by a game.

## Installation

Install `Rust` from your package manager or by downloading from here:
[https://rust-lang.org/](https://rust-lang.org/).

## Build

Build using release mode and install locally (on GNU/Linux this is `~/.cargo/bin`):

```sh
cargo install --locked --path .
```

## Example usage

Show available options:

```sh
flow-texpack -h
flow-texpack --help
```

Examples:

```sh
flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r -p 2 -v
flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r -p 2 -v --load-filter png tga
flow-texpack -i data -e data/tiles -o out/atlas -m -t -u -r --atlas-size pot2048 --rect-heuristic area-fit -v
flow-texpack --input-file input.txt --exlude-file exclude.txt -o out/atlas -v
flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r --adjust-size -v
flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r --adjust-fit -v
```

## LICENSE

See the file 'LICENSE' for license information.