cluttered

A CLI Texture Packer written in rust that can pack a bunch of images optimally based on crunch-rs. Supports many formats as well including json, binary and ron.

Usage

This CLI Texture Packer is based around the config file, which you would have to create in order to pack the images. Example content of the config file with ron format: ron // Json is also supported PackerConfig( name: "gem-collections", output_path: "out", // In Json format, output_type is a string. output_type: Json, folders: [ "images/common", "images/rare", "images/legendary" ], options: PackerConfigOptions( max_size: 4096, show_extension: false ) ) Then, in the CLI usage:

cluttered config --input <INPUT>

Example:

cluttered config --input packer-config.ron

Alternatively, we can use the manual way, which we can use the argument called pack

cluttered pack --input <[INPUT]> --output <OUTPUT>

Example:

cluttered pack --input images/legendary images/rare --output out --type json

Pack Arguments

|name |description| |-------------|-----------| |--type |Specify the output type. |--name |Specify the name of the output.

Binary Format

[String] - Name [UInt32] - Count (Use it in for loops below) L [String] - Name [UInt32] - X [UInt32] - Y [UInt32] - Width [UInt32] - Height

Template

We also support custom template with handlebars write your own custom template to support your favourite format or make a new one.

Example usage on xml format: xml <TextureAtlas imagePath="{{atlas.sheet_path}}"> {{#each atlas.frames as frame}} <Texture name="{{@key}}" x="{{this.x}}" y="{{this.y}}" width="{{this.width}}" height="{{this.height}}"/> {{/each}} </TextureAtlas>

Global Variables

|Name |Type | |-------------|-----------| |config |PackerConfig |atlas |PackerAtlas

PackerConfig

|Name |Type | |-------------|-----------| |name |String |outputpath |String |outputtype |OutputType/String |folders |String[] |template_path|String? |options |PackerConfigOptions

OutputType

|Name | |-------------| |Json | |Binary | |Ron | |Template |

PackerConfigOptions

|Name |Type | |--------------|-----------| |maxsize |int |showextension|bool

PackerAtlas

|Name |Type | |--------------|-----------| |sheet_path |String |frames |HashMap

TextureData

|Name |Type | |--------------|-----------| |x |int |y |int |width |int |height |int