Skip to content
animfetch
Menu

Art

Animations

Choose a built-in animation, and make your own from a folder of text frames.

animfetch ships with 34 animations compiled into the binary. See them all playing.

Choosing one#

sh
animfetch --list             # what is available (* marks the current one)
animfetch -a cat-tail        # different animation, this run only
animfetch --set cat-tail     # make it the default

--set writes animation = "cat-tail" to your config. Naming an animation that does not exist is an error that says where it looked, never a silent fallback to the default.

Making your own#

An animation is a folder of text files, one per frame. Put it here:

~/.config/animfetch/anim/<name>/
  00.txt
  01.txt
  02.txt
  ...

Then run it with animfetch -a <name> or --set <name>; it appears in --list with its path.

The rules:

  • Every .txt file in the folder is a frame, sorted by file name. Sorting decides the order, so zero-pad: 00.txt, 01.txt, … 10.txt, not 1.txt and 10.txt.
  • Anything that is not whitespace is ink. A space is empty.
  • Frames may differ in size. The width is the widest line across the frame.
  • A folder of yours shadows a built-in of the same name, so you can replace one.
  • Colour is optional. Frames may carry truecolor escape sequences (SGR foreground colours); the raw style shows them and the half/quad styles use the gradient. See Colours and art styles.

A frame is just text:

   /\_/\
  ( o.o )
   > ^ <

For solid block styles (half, quad) the art is read as a silhouette: ink or no ink. For raw, the characters are the picture, so author them as you want them seen.

Sizing#

The art is scaled to fit width by height cells and never enlarged beyond how it was drawn. Author at the size you want it to appear, and let the caps shrink it on smaller terminals:

toml
width  = 56
height = 20

Speed#

fps is frames per second, clamped to 1-120. The default is 12.

sh
animfetch --pin --fps 20

The built-in set#

bat, bird, blackhole, boxing, butterfly, cat-run, cat-tail, chicken-run, coelho, conejito, deer-run, dolphin-swim, dragon, earth, fire, fire2, fox-run, girl-dance, gojo-dance, gojo-dance2, horse-run, icosahedron, mew, morty-dance, osaka-spin, pikachu, rabbit-run, rabbit-sit, rocket, saturn, squirrel-run, suba-cat, tree, yin-yang.

Some animations are redrawn as ASCII from RunCat by kyome22, used under the Apache License 2.0.