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.
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,
features: (
nine_patch: true
)
)
)
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
|name |description| |-------------|-----------| |--type |Specify the output type. |--name |Specify the name of the output.
[String] - Name
[UInt32] - Count (Use it in for loops below)
L [String] - Name
[UInt32] - X
[UInt32] - Y
[UInt32] - Width
[UInt32] - Height
[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)
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>
|Name |Type | |-------------|-----------| |config |PackerConfig |atlas |PackerAtlas
|Name |Type | |-------------|-----------| |name |String |outputpath |String |outputtype |OutputType/String |folders |String[] |template_path|String? |options |PackerConfigOptions
|Name | |-------------| |Json | |Binary | |Ron | |Template |
|Name |Type | |--------------|-----------| |maxsize |int |showextension|bool |features |Features
|Name |Type | |--------------|-----------| |nine_patch |bool
|Name |Type |
|--------------|-----------|
|sheet_path |String
|frames |HashMap
|Name |Type |
|--------------|-----------|
|x |int
|y |int
|width |int
|height |int
|nine_patch |Option
|Name |Type | |--------------|-----------| |x |int |y |int |w |int |h |int