README.md

   1 # flow-texpack
   2
   3 `flow-texpack` is a program that will allow you to generate texture atlas from
   4 input images (BMP, HDR, JPG, PNG, TGA, TIFF, WEBP). The application generates
   5 both texture atlas and descriptions file that can be read by a game.
   6
   7 ## Installation
   8
   9 Install `Rust` from your package manager or by downloading from here:
  10 [https://rust-lang.org/](https://rust-lang.org/).
  11
  12 ## Build
  13
  14 Build using release mode and install locally (on GNU/Linux this is `~/.cargo/bin`):
  15
  16 ```sh
  17 cargo install --locked --path .
  18 ```
  19
  20 ## Example usage
  21
  22 Show available options:
  23
  24 ```sh
  25 flow-texpack -h
  26 flow-texpack --help
  27 ```
  28
  29 Examples:
  30
  31 ```sh
  32 flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r -p 2 -v
  33 flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r -p 2 -v --load-filter png tga
  34 flow-texpack -i data -e data/tiles -o out/atlas -m -t -u -r --atlas-size pot2048 --rect-heuristic area-fit -v
  35 flow-texpack --input-file input.txt --exlude-file exclude.txt -o out/atlas -v
  36 flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r --adjust-size -v
  37 flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r --adjust-fit -v
  38 ```
  39
  40 ## LICENSE
  41
  42 See the file 'LICENSE' for license information.