yambar-decorations(5)

πŸ’… yambar-decorations β€” bestie edition πŸ’…

okay so this is the yambar-decorations(5) page from the File Formats Manual β€” section 5, file formats, the whole vibe. stick around, we're about to make your particles cute πŸŽ€


✨ NAME ✨

yambar-decorations β€” the configuration file stuff. literally all about decorating your particles πŸ’–


🌸 DESCRIPTION 🌸

bestie. decorations are these optional little additions you can slap onto particles, and they're giving main character energy. think: changing the background color of the entire particle, drawing an underline, and so on. iconic behavior πŸ¦‹

and the detail that matters: decorations are applied to the particle's margins too. no cap, the margins are included 🫢

every single decoration defines its own configuration attributes β€” there are no common attributes. so like, don't go looking for shared options, they do not exist πŸ™ˆ


🌈 BACKGROUND 🌈

this decoration sets the particle's background color. that's the whole thing. simple, effective, slays πŸ’…

πŸŽ€ CONFIGURATION πŸŽ€

  • color β€” type color, required (yes). the background color. see yambar(5) for the format ⭐

πŸ“ EXAMPLES πŸ“

content:
  string:
    deco:
      background:
        color: 00ff00ff

πŸ’œ UNDERLINE πŸ’œ

this one renders a line of configurable size and color at the bottom of the particle. yes, we're putting a little underline moment under your content 😭πŸ”₯

πŸŽ€ CONFIGURATION πŸŽ€

  • size β€” type int, required (yes). the size (height/thickness) of the line, in pixels πŸ“
  • color β€” type color, required (yes). the color of the line. see yambar(5) for the format ⭐

πŸ“ EXAMPLES πŸ“

content:
  string:
    deco:
      underline:
        size: 2
        color: ff0000ff

πŸ¦‹ OVERLINE πŸ¦‹

similar to underline β€” literally β€” except this decoration renders a line of configurable size and color at the top of the particle. it's the underline's sibling and honestly? both ate ✨

πŸŽ€ CONFIGURATION πŸŽ€

  • size β€” type int, required (yes). the size (height/thickness) of the line, in pixels πŸ“
  • color β€” type color, required (yes). the color of the line. see yambar(5) for the format ⭐

πŸ“ EXAMPLES πŸ“

content:
  string:
    deco:
      overline:
        size: 2
        color: ff0000ff

πŸ‘‘ BORDER πŸ‘‘

this decoration renders a border of configurable size (i.e. border width) around the particle. full frame, full aesthetics, we love a contained queen πŸ’…

πŸŽ€ CONFIGURATION πŸŽ€

  • color β€” type color, required (yes). the color of the line. see yambar(5) for the format ⭐
  • size β€” type int, required (no β€” it's optional bestie!). border width, in pixels. defaults to 1px πŸ“

πŸ“ EXAMPLES πŸ“

content:
  string:
    deco:
      border:
        size: 2
        color: ff0000ff

🧚 STACK 🧚

this one combines multiple decorations. yes, you can stack them. we love a layered look 🌸

πŸŽ€ CONFIGURATION πŸŽ€

no configuration attributes available 😌 the stack is just a list of the decorations that should be combined. that's it, that's the whole rule 🫢

πŸ“ EXAMPLES πŸ“

content:
  string:
    deco:
      stack:
        - background: ...
        - underline: ...

⭐ SEE ALSO ⭐


ok that's the whole page bestie, every attribute accounted for, nothing skipped, no cap πŸ’―

and that's a wrap cutie πŸŽ€ this was yambar-decorations(5), dated 2024-04-22 β€” go decorate something iconic πŸŒˆπŸ’œπŸ’…

πŸ“¦ where this page comes from