Flairs

Flairs are cosmetic sprite overlays for monsters.

An individual monster can be given flairs (one per category, with any number of categories able to be defined), or have them removed or replaced, by an event action.

Flair definitions

Each flair is defined in a YAML file (mods/tuxemon/db/flair/*.yaml), with a corresponding PNG in gfx/sprites/flairs/<sprite_type_override or category>/.

- slug: stars
  category: common
  weight: 1.0
  layer: 0
  layer_order: 0
  x_offset: null
  y_offset: null
  sprite_type:
  - front
  sprite_type_override: null
  color: null

• slug — unique name of the flair and its corresponding PNG.
• category — grouping, e.g. common, rare, or hat. Only one flair per category can be active on a monster. Also the default folder name for the PNG.
• weight — Not fully functional; set to 1.0.
• layer — Flairs with higher numbers appear on top of flairs with lower numbers.
• layer_order — Flairs with lower numbers appear on top of flairs of the same layer with higher layer_order numbers.
• x_offset — Horizontal offset from the sprite origin. null is treated as 0.
• y_offset — Vertical offset from the sprite origin. null is treated as 0.
• sprite_type — Which views this flair appears on: front, back, menu01, menu02. null means all views (unlikely to work since types vary from 24 × 24 to 64 × 64 pixels).
• sprite_type_override — Overrides the folder used in the art path. Use it to share one image across categories, e.g. universal.
• color — Optional RGBA tint applied to the flair image.