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.

It can be used for games with Godot, Monogame or a bunch more that needed to optimize the memory usage.

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 toml format: ```toml name = "gemcollections" outputpath = "samples/out" outputtype = "Json" templatepath = "samples/xml-template.xml" folders = [ "samples/images/common", "samples/images/rare", "samples/images/legendary", "samples/images/rect" ]

[imageoptions] outputextension = "Png" maxsize = 4096 showextension = false

[features] nine_patch = true ``` Then, in the CLI usage:

cluttered config --input <INPUT>

Example:

cluttered config --input packer-config.toml

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. |--templatepath|Specify the template path for the custom template output.

Binary Format

[String] - Name [UInt32] - Count (Use it in for loops below) L [String] - Name [UInt32] - X [UInt32] - Y [UInt32] - Width [UInt32] - Height [Bool] - HasNinePatch (if nine_patch is enabled) [UInt32] - X (if nine_patch is enabled and has a file) [UInt32] - Y (if nine_patch is enabled and has a file) [UInt32] - W (if nine_patch is enabled and has a file) [UInt32] - H (if nine_patch is enabled and has a file)

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}}" {{#if this.nine_patch}} nx="{{this.nine_patch.x}}" ny="{{this.nine_patch.y}}" nw="{{this.nine_patch.w}}" nh="{{this.nine_patch.h}}" {{/if}} /> {{/each}} </TextureAtlas>

Global Variables

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

Config

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

OutputType

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

ImageOptions

|Name |Type | |-----------------|-----| |maxsize |int | |outputextension |OutputExtensionType/String |show_extension |bool

OutputExtensionType

| Name | |------| |Png | |Qoi | |Jpg |

Features

|Name |Type | |--------------|-----------| |nine_patch |bool

PackerAtlas

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

TextureData

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

Rect

|Name |Type | |--------------|-----------| |x |int |y |int |w |int |h |int