yaap/README.md

31 lines
1.5 KiB
Markdown

# YAAP
Yet-Another-Atlas-Packer by bersK (Stefan Stefanov)
## Usage & requirements
> [!IMPORTANT]
> Pull this repo with `--recursive`, the `odin-aseprite` library is pulled in as a submodule.
At least odin compiler version `dev-2025-07:204edd0fc`
Since we need to download/compile some 3rd party dependencies in the vendors folder we need to call
`scripts/setup.[sh|bat]` to compile libtinydialog & download the already compiled `clay` binaries and bindings.
## Description
> [!NOTE]
> Quite frankly if you want automatic atlas packing I would suggest using `stb_rect_pack` directly & an aseprite plugin for exporting your assets in a proper format for packing. Using this atlas packer in an automated fashion is not quite possible and slower as a workflow. I would only use it for experiment projects or places where having a built in atlas packer is not practical.
Simple atlas packer for `.aseprite` files. Generates a packed png & metadata in the form of json and/or source files(cpp, odin, etc...).
> [!CAUTION]
> Does not handle palette files currently.
Uses `stb_rect_pack` for the image packing & `raylib` for the UI.
A quick preview on [youtube](https://youtu.be/4_dKq7G57Lw).
<img src="https://raw.githubusercontent.com/bersK/yaap/master/repo_assets/image.png" />
## Dependencies
* odin-aseprite [github](https://github.com/blob1807/odin-aseprite)
* raylib (`vendor/raylib`, [link](https://github.com/odin-lang/Odin/tree/master/vendor/raylib))
* stb_rect_pack (`vendor/stb/rect_pack`, [link](https://github.com/odin-lang/Odin/tree/master/vendor/stb/rect_pack))