🗺️ clymene

An atlas image and data generation tool.

The main target is to aid game devs at atlas packing and data processing. It doesn't just outputs a packed image, but also a data set about it's sources, which can be either static images or animations.

Design Goals

• Fast as possible: minimize atlas generation time whenever is possible.
• Additive execution: re-execution should be smart enough to only process the differences.
• Configurable: be able to specify everything from a project config file.
• Command-line based: serve as a command-line tool and nothing else.

Features

• Input file formats
  • .aseprite, .ase
• Output formats
  • .png + .json
• Multithreaded sources processing
• Cached data to speed up next executions
• Configuration .toml file (cli options always overrides it, more info at --help)

Building

git clone https://github.com/lucas-miranda/clymene
cd clymene
cargo build --release

Usage

1. Build or grab latest release
2. Get config file, by one of following methods:
   1. Run clymene, it'll generate a default config
   2. Take config.toml file and put it aside clymene executable
3. Open config.toml and change:
   • image.input_path: directory to retrieve image sources
4. Additionally, you can modify:
   • output.path: directory where clymene should outputs
   • output.name: to give a custom output filename
   • packer.atlas_size: atlas target size (width and height),
5. Run clymene!

More options are commented out at config file, check it out for more settings.

Documentation

See docs/ to more in-depth details about formats and other things.

License

Clymene is under MIT License.