fastpack 0.7.2

FastPack — modern texture atlas packer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# FastPack

[![crates.io](https://img.shields.io/crates/v/fastpack.svg)](https://crates.io/crates/fastpack)
[![CI](https://github.com/Hexeption/FastPack/actions/workflows/ci.yml/badge.svg)](https://github.com/Hexeption/FastPack/actions/workflows/ci.yml)
[![rustc 1.85+](https://img.shields.io/badge/rustc-1.85%2B-orange.svg)](https://www.rust-lang.org)

Texture atlas packer written in Rust 2024. Replaces TexturePacker with a native GUI as the primary interface, plus a full-featured CLI and TUI.

## Features

- **Packing algorithms** — MaxRects (5 heuristics), Grid, Basic strip
- **Trim modes** — None, Trim, Crop, CropKeepPos, Polygon (convex hull)
- **Export formats** — JSON Hash, JSON Array, Phaser 3, PixiJS
- **Compression** — PNG via oxipng (lossless), JPEG via mozjpeg, WebP, lossy PNG via imagequant
- **Alias detection** — content-hash dedup with pixel verification
- **Sprite features** — extrusion, rotation, nine-patch metadata, pivot points
- **Multi-resolution** — scale variants with per-variant suffix and resampling filter
- **Watch mode** — repack on file change
- **Project files** — `.fpsheet` TOML format
- **Multipack** — overflow sprites across multiple atlas sheets

## Install

Download a prebuilt binary from the [releases page](https://github.com/Hexeption/FastPack/releases).

Or install from crates.io:

```sh
cargo install fastpack
```

## Usage

```sh
# Open the GUI (default when no subcommand is given)
fastpack

# Pack a directory of sprites
fastpack pack sprites/ --output output/

# Pack with options
fastpack pack sprites/ --output output/ \
  --max-width 2048 --max-height 2048 \
  --trim-mode trim \
  --data-format phaser3 \
  --allow-rotation

# Load settings from a project file
fastpack pack --project atlas.fpsheet

# Watch for changes and repack automatically
fastpack watch sprites/ --output output/

# Split an atlas back into individual sprites
fastpack split atlas.png atlas.json --output-dir sprites/

# Generate a default project file
fastpack init --output atlas.fpsheet

# Open the TUI
fastpack tui atlas.fpsheet
```

## Project File

Settings live in a `.fpsheet` TOML file:

```toml
[meta]
version = "1"

[output]
name = "atlas"
directory = "output/"
texture_format = "png"
pixel_format = "rgba8888"
data_format = "json_hash"
quality = 95

[layout]
max_width = 4096
max_height = 4096
size_constraint = "pot"
force_square = false
allow_rotation = true
pack_mode = "good"
border_padding = 2
shape_padding = 2

[sprites]
trim_mode = "trim"
trim_threshold = 1
extrude = 0
detect_aliases = true

[algorithm]
type = "max_rects"
heuristic = "best_short_side_fit"

[[variants]]
scale = 1.0
suffix = "@1x"
mode = "smooth"

[[sources]]
path = "sprites/"
filter = "**/*.png"
```

## Export Formats

`data_format` in the project file or `--data-format` on the CLI accepts:

- `json_hash` — TexturePacker-compatible JSON with frames as an object keyed by sprite ID. Default.
- `json_array` — Same structure but frames as an array, each entry with a `filename` field.
- `phaser3` — Single JSON file with a `textures` array. Compatible with `scene.load.multiatlas()`.
- `pixijs` — JSON Hash format; identical output to `json_hash`, distinguished by format ID.

## License

Licensed under [MIT](LICENSE).