Documentation
Docs/en/reference/image-format/options.md
Legacy Image Filename Options
Generated reference. Do not edit directly. Update
BuildTools/ImageFormatInterface.json, then runpython BuildTools/docs_image_format.py --write.
| Index | Formats | FOFRM | Options | Baking | Runtime | Validation | Canonical JSON | Guide |
| Stable ID | Syntax | Behavior | Why | Source |
|---|---|---|---|---|
image-format.option.art |
Name$[0-3][T][H][V][Fframe|Ffrom-to].art |
Digits select the last requested available palette, T derives alpha from maximum RGB while index zero remains transparent, H/V mirror, and F selects an inclusive ascending or descending clamped frame/range; letters are case-insensitive and unknown characters are ignored. | Options are parsed from the source reference without changing the physical source filename. | Source/Tools/ImageBaker-Art.cpp |
image-format.option.spr |
Name$[part,r,g,b]...Sequence.spr |
Zero or more bracket entries set clamped RGB offsets for part 0 other, 1 skin, 2 hair, or 3 armor; an out-of-range part applies the RGB values to all parts, and text after the last bracket selects a sequence case-insensitively (empty selects the first). | The importer composes palette layers and animation selection before writing runtime RGBA frames. | Source/Tools/ImageBaker-Spr.cpp |
image-format.option.bam |
Name$cycle[-frame].bam |
The integer before ‘-‘ selects a cycle and an optional non-negative integer after ‘-‘ selects one frame; out-of-range cycle/frame values fall back to zero, while no frame selector imports the whole cycle. | The source can expose many cycles while one resource path needs deterministic output. | Source/Tools/ImageBaker-Bam.cpp |
image-format.option.art-rotation |
Name$[0-3]r=<digit 0..7>[T][H][V][Fframe|Ffrom-to].art |
The ART loader interprets r= or R= followed by exactly one digit 0..7 as a clockwise rotation from north and emits one direction. Palette selection precedes r=; mirror, alpha and frame options may follow. Invalid values or trailing characters outside those options fail baking. Single-rotation sources reuse their stored frame with placement for the requested rotation. Without the equals sign, r/R remains ignored and a following 0..3 still selects a palette. | Source filename options work identically through Alias and ordinary frm references; FOFRM and generic dispatch do not interpret ART-specific options or bypass a registered loader. | Source/Tools/ImageBaker-Art.cpp |