cmd

Overview ¶

Package main provides a command-line tool for sprite atlas packing and unpacking.

This tool supports: - Creating optimized sprite atlases from individual images - Unpacking existing sprite atlases back to individual images - Multiple packing algorithms and heuristics - Various sprite processing options

Usage:

spritepacker -input <dir> [options]       # Pack mode
spritepacker -unpack <json> [options]     # Unpack mode

Packing Options:

-input string      Input directory containing sprite images (required for packing)
-output string     Output directory (default "output")
-maxw int          Maximum atlas width (default 2048)
-maxh int          Maximum atlas height (default 2048)
-padding int       Padding between sprites (default 2)
-rotate            Allow sprite rotation to save space
-pot               Force power-of-two atlas dimensions
-pma               Use premultiplied alpha
-name string       Base name for output files (default "atlas")
-sort              Sorts sprites before packing (default true)
-trim              Trims transparent edges (default true)
-tolerance int     Transparency tolerance for trimming (0-255, default 1)
-same              Enable identical image detection (default true)
-algo int          Packing algorithm (0=Basic, 1=Skyline, 2=MaxRects)
-heuristic int     MaxRects heuristic (0-4, see docs)

Unpacking Options:

-unpack string     JSON file to unpack (required for unpacking)
-img string        Atlas image path (optional, will search by name)
-output string     Output directory for unpacked sprites

Examples:

# Pack sprites with default settings
spritepacker -input ./sprites -output ./atlases

# Pack with custom settings
spritepacker -input ./sprites -maxw 1024 -maxh 1024 -padding 4 -rotate

# Unpack atlas
spritepacker -unpack ./atlases/atlas.json -output ./unpacked

The package includes: - Multiple packing algorithms (Basic, Skyline, MaxRects) - Support for common image formats (PNG, JPEG, BMP, TIFF) - Sprite trimming and optimization features - JSON metadata generation