Effects Showroom
The effects shown below represent the built-in library of effects and their default configuration.
Beams
Creates beams which travel over the canvas illuminating the characters.
Beams Command Line Arguments
--beam-row-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Symbols to use for the beam effect when moving along a row. Strings will be used in sequence to create an
animation. (default: ▂ ▁ _)
--beam-column-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Symbols to use for the beam effect when moving along a column. Strings will be used in sequence to create an
animation. (default: ▌ ▍ ▎ ▏)
--beam-delay (int > 0)
Number of frames to wait before adding the next group of beams. Beams are added in groups of size random(1, 5).
(default: 6)
--beam-row-speed-range (hyphen separated positive int range e.g. '1-10')
Speed range of the beam when moving along a row, in tenths of a character per frame. (default: 15-60)
--beam-column-speed-range (hyphen separated positive int range e.g. '1-10')
Speed range of the beam when moving along a column, in tenths of a character per frame. (default: 9-15)
--beam-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the beam, a gradient will be created between the colors. (default:
ffffff 00d1ff 8a008a)
--beam-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, numbers for the gradient steps to use. More steps will create a smoother and longer
gradient animation. Steps are paired with the colors in beam-gradient-stops. (default: 2 6)
--beam-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 2)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the wipe gradient. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 4)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
--final-wipe-speed (int > 0)
Speed of the final wipe as measured in diagonal groups activated per frame. (default: 3)
Example: terminaltexteffects beams --beam-row-symbols ▂ ▁ _ --beam-column-symbols ▌ ▍ ▎ ▏ --beam-delay 6 --beam-row-speed-range 15-60 --beam-column-speed-range 9-15 --beam-gradient-stops ffffff 00D1FF 8A008A --beam-gradient-steps 2 6 --beam-gradient-frames 2 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-frames 4 --final-gradient-direction vertical --final-wipe-speed 3
BinaryPath
Decodes characters into their binary form. Characters travel from outside the canvas towards their input coordinate, moving at right angles.
BinaryPath Command Line Arguments
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 00d500 007500)
--final-gradient-steps (int > 0) [(int > 0) ...]
Number of color-transition steps used for the spatial final-color gradient. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: radial)
--binary-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the binary characters. Character color is randomly assigned from
this list. (default: 044e29 157e38 45bf55 95ed87)
--movement-speed (float > 0)
Speed of the binary groups along right-angle paths from outside the canvas toward their input coordinates.
(default: 1)
--active-binary-groups (0 <= float(n) <= 1)
Maximum fraction of binary groups active at once. Values range from 0 to 1; 0 still activates one group.
(default: 0.08)
Example: terminaltexteffects binarypath --final-gradient-stops 00d500 007500 --final-gradient-steps 12 --final-gradient-direction radial --binary-colors 044E29 157e38 45bf55 95ed87 --movement-speed 1 --active-binary-groups 0.08
Blackhole
Creates a blackhole in a starfield, consumes the stars, explodes the input data back into position.
Blackhole Command Line Arguments
--blackhole-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the stars that comprise the blackhole border. (default: ffffff)
--star-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Colors used for the collapse point and to color characters during the explosion before they cool to their final
color. (default: ffcc0d ff7326 ff194d bf2669 702a8c 049dbf)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Number of transitions used between final gradient stops to create color levels across the canvas. More
transitions add spatial color detail but do not change animation duration. (default: 9)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Example: terminaltexteffects blackhole --blackhole-color ffffff --star-colors ffcc0d ff7326 ff194d bf2669 702a8c 049dbf --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 9 --final-gradient-direction diagonal
BouncyBalls
Characters fall from the top of the canvas as bouncy balls before settling into place.
Bouncyballs Command Line Arguments
--ball-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated list of colors from which ball colors will be randomly selected. If no colors are provided, the
colors are random. (default: d1f4a5 96e2a4 5acda9)
--ball-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated list of symbols to use for the balls. (default: * o O 0 .)
--ball-delay (int >= 0)
Number of frames between ball-drop batches; 0 removes the delay between batches. (default: 4)
--movement-speed (float > 0)
Movement speed of the characters. (default: 0.45)
--movement-easing MOVEMENT_EASING
Easing function to use for character movement. (default: out_bounce)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: f8ffae 43c6ac)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects bouncyballs --ball-colors d1f4a5 96e2a4 5acda9 --ball-symbols '*' o O 0 . --ball-delay 4 --movement-speed 0.45 --movement-easing OUT_BOUNCE --final-gradient-stops f8ffae 43c6ac --final-gradient-steps 12 --final-gradient-direction diagonal
Bubbles
Forms bubbles with the characters. Bubbles float down and pop.
Bubbles Command Line Arguments
--rainbow
If set, the bubbles will be colored with a rotating rainbow gradient. (default: False)
--bubble-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the bubbles. Ignored if --rainbow is set. (default: d33aff 7395c4
43c2a7 02ff7f)
--pop-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the spray emitted when a bubble pops. (default: ffffff)
--bubble-speed (float > 0)
Speed of the floating bubbles. (default: 0.5)
--bubble-delay (int >= 0)
Number of frames between bubbles. (default: 20)
--pop-condition {row,bottom,anywhere}
Condition for a bubble to pop. 'row' will pop the bubble when it reaches the lowest row for which a character in
the bubble originates. 'bottom' will pop the bubble at the bottom row of the terminal. 'anywhere' will pop the
bubble randomly, or at the bottom of the terminal. (default: row)
--movement-easing (Easing Function)
Easing function to use for character movement after a bubble pops. (default: in_out_sine)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: d33aff 02ff7f)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects bubbles [--rainbow] --bubble-colors d33aff 7395c4 43c2a7 02ff7f --pop-color ffffff --bubble-speed 0.5 --bubble-delay 20 --pop-condition row --movement-easing IN_OUT_SINE --final-gradient-stops d33aff 02ff7f --final-gradient-steps 12 --final-gradient-direction diagonal
Burn
Characters are ignited and burn up the screen.
Burn Command Line Arguments
--starting-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color of the characters before they start to burn. (default: 837373)
--burn-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Colors transitioned through as the characters burn. (default: ffffff fff75d fe650d 8a003c 510100)
--smoke-chance (0 <= float(n) <= 1)
Chance a given character will produce smoke while burning. Use 0 for no smoke. (default: 0.5)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 00c3ff ffff1c)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects burn --starting-color 837373 --burn-colors ffffff fff75d fe650d 8a003c 510100 --smoke-chance 0.5 --final-gradient-stops 00c3ff ffff1c --final-gradient-steps 12 --final-gradient-direction vertical
ColorShift
Display a gradient that shifts colors across the terminal.
Note
Demo GIF uses --travel and --travel-direction radial arguments.
ColorShift Command Line Arguments
--gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the gradient. (default: e81416 ffa500 faeb36 79c314 487de7 4b369d
70369d)
--gradient-steps (int > 0) [(int > 0) ...]
Number of gradient steps to use. More steps will create a smoother gradient animation. (default: 12)
--gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 2)
--no-travel
Do not display the gradient as a wave. (default: False)
--travel-direction (diagonal, horizontal, vertical, radial)
Direction the gradient travels across the canvas. (default: radial)
--reverse-travel-direction
Reverse the gradient travel direction. (default: False)
--no-loop
Do not loop the gradient. If not set, the gradient generation will loop the final gradient color back to the
first gradient color. (default: False)
--cycles (int >= 0)
Number of times to cycle the gradient. Use 0 for infinite cycling. (default: 3)
--skip-final-gradient
Skip the final gradient. (default: False)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: e81416 ffa500 faeb36 79c314 487de7
4b369d 70369d)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects colorshift --gradient-stops e81416 ffa500 faeb36 79c314 487de7 4b369d 70369d --gradient-steps 12 --gradient-frames 2 [--no-loop] [--no-travel] --travel-direction radial [--reverse-travel-direction] --cycles 3 [--skip-final-gradient] --final-gradient-stops e81416 ffa500 faeb36 79c314 487de7 4b369d 70369d --final-gradient-steps 12 --final-gradient-direction vertical
Crumble
Characters crumble into dust before being vacuumed up and reformed.
Crumble Command Line Arguments
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 5ce1ff ff8c00)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Example: terminaltexteffects crumble --final-gradient-stops 5CE1FF FF8C00 --final-gradient-steps 12 --final-gradient-direction diagonal
Decrypt
Movie style text decryption effect.
Decrypt Command Line Arguments
--typing-speed (int > 0)
Number of characters typed per keystroke. (default: 2)
--ciphertext-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the ciphertext. Color will be randomly selected for each
character. (default: 008000 00cb00 00ff00)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: eda000)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects decrypt --typing-speed 2 --ciphertext-colors 008000 00cb00 00ff00 --final-gradient-stops eda000 --final-gradient-steps 12 --final-gradient-direction vertical
ErrorCorrect
Swaps characters from an incorrect initial position to the correct position.
ErrorCorrect Command Line Arguments
--error-pairs (0 <= float(n) <= 1)
Fraction of characters that are in the wrong position, from 0 to 1.0. The displaced-character count is rounded
to the nearest whole pair, with half pairs rounded up; positive fractions schedule at least one pair when
possible. (default: 0.1)
--swap-delay (int >= 0)
Number of frames between swaps. Use 0 to swap pairs without a delay. (default: 6)
--error-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the characters that are in the wrong position. (default: e74c3c)
--correct-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the characters once corrected, this is a gradient from error-color and fades to final-color. (default:
45bf55)
--movement-speed (float > 0)
Speed of the characters while moving to the correct position. (default: 0.9)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects errorcorrect --error-pairs 0.1 --swap-delay 6 --error-color e74c3c --correct-color 45bf55 --movement-speed 0.9 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction vertical
Expand
Characters expand from the center.
Expand Command Line Arguments
--expand-easing EXPAND_EASING
Easing function to use for character movement. (default: in_out_quart)
--movement-speed (float > 0)
Movement speed of the characters. (default: 0.35)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects expand --final-gradient-stops 8A008A 00D1FF FFFFFF --final-gradient-steps 12 --final-gradient-direction vertical --movement-speed 0.35 --expand-easing IN_OUT_QUART
Fireworks
Launches characters up the screen where they explode like fireworks and fall into place.
Fireworks Command Line Arguments
--explode-anywhere
If set, fireworks explode anywhere in the canvas. Otherwise, fireworks explode above highest settled row of
text. (default: False)
--firework-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated list of colors from which firework colors will be randomly selected. (default: 88f7e2 44d492
f5eb67 ffa15c fa233e)
--firework-symbol (ASCII/UTF-8 character)
Symbol to use for the firework shell. (default: o)
--firework-volume (0 <= float(n) <= 1)
Fraction of input characters in each firework shell. 0 produces the minimum shell size of one character.
(default: 0.05)
--launch-delay (int >= 0)
Number of frames to wait between launching each firework shell. +/- 0-50 percent randomness is applied to this
value. (default: 45)
--explode-distance (0 <= float(n) <= 1)
Maximum distance from the firework shell origin to the explode waypoint as a fraction of the total canvas width.
0 produces a minimum distance of one cell. (default: 0.2)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: horizontal)
Example: terminaltexteffects fireworks [--explode-anywhere] --firework-colors 88F7E2 44D492 F5EB67 FFA15C FA233E --firework-symbol o --firework-volume 0.05 --launch-delay 45 --explode-distance 0.2 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction horizontal
Highlight
Run a specular highlight across the text.
Highlight Command Line Arguments
--highlight-brightness (float > 0)
Brightness of the highlight color. Values less than 1 will darken the highlight color, while values greater than
1 will brighten the highlight color. (default: 1.75)
--highlight-direction column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Character order for highlight activation: spatial groups or individual traversal, including spirals. (default:
diagonal_bottom_left_to_top_right)
--reverse-highlight-direction
Reverse the complete highlight direction traversal. (default: False)
--highlight-width (int > 0)
Width of the highlight. n >= 1 (default: 8)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects highlight --highlight-brightness 1.75 --highlight-direction diagonal_bottom_left_to_top_right --highlight-width 8 --final-gradient-stops 8A008A 00D1FF FFFFFF --final-gradient-steps 12 --final-gradient-direction vertical
LaserEtch
A laser etches characters onto the terminal.
LaserEtch Command Line Arguments
--etch-pattern algorithm column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Pattern used to etch the text: algorithm, serpentine character groups, or exact character sorts. (default:
algorithm)
--reverse-etch-pattern
Reverse the complete etch pattern traversal. (default: False)
--etch-speed (int > 0)
Along with etch_delay, determines the speed at which the characters are etched onto the terminal. This value
specifies the number of characters to etch simultaneously. (default: 1)
--etch-delay (int >= 0)
Along with etch_speed, determines the speed at which the characters are etched onto the terminal. This values
specifies the number of frames to wait before etching the next set of characters. (default: 1)
--cool-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the gradient used to cool the characters after etching. If only
one color is provided, the characters will be displayed in that color. (default: ffe680 ff7b00)
--laser-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the laser gradient. If only one color is provided, the characters
will be displayed in that color. (default: ffffff 376cff)
--spark-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the spark cooling gradient. If only one color is provided, the
characters will be displayed in that color. (default: ffffff ffe680 ff7b00 1a0900)
--spark-cooling-frames (int > 0)
Number of frames to display each spark cooling gradient step. Increase to slow down the rate of cooling.
(default: 7)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 8)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 4)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects laseretch --etch-pattern algorithm --etch-speed 1 --etch-delay 1 --cool-gradient-stops ffe680 ff7b00 --laser-gradient-stops ffffff 376cff --spark-gradient-stops ffffff ffe680 ff7b00 1a0900 --spark-cooling-frames 7 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 8 --final-gradient-frames 4 --final-gradient-direction vertical
Matrix
Matrix digital rain effect.
Matrix Command Line Arguments
--highlight-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the bottom of the rain column. (default: dbffdb)
--rain-color-gradient (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the rain gradient. Colors are selected from the gradient randomly.
If only one color is provided, the characters will be displayed in that color. (default: 92be92 185318)
--rain-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated, unquoted, list of symbols to use for the rain. (default: 2 5 9 8 Z * ) : . " = + - ¦ | _ ｦ ｱ ｳ
ｴ ｵ ｶ ｷ ｹ ｺ ｻ ｼ ｽ ｾ ｿ ﾀ ﾂ ﾃ ﾅ ﾆ ﾇ ﾈ ﾊ ﾋ ﾎ ﾏ ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾗ ﾘ ﾜ)
--rain-fall-delay-range (hyphen separated positive int range e.g. '1-10')
Range for the speed of the falling rain as determined by the delay between rows. Actual delay is randomly
selected from the range. (default: 2-15)
--rain-column-delay-range (hyphen separated positive int range e.g. '1-10')
Range of frames to wait between adding new rain columns. (default: 3-9)
--rain-time (int > 0)
Time, in seconds, to display the rain effect before transitioning to the input text. (default: 15)
--symbol-swap-chance (0 <= float(n) <= 1)
Probability of swapping a character's symbol on each tick, from 0 to 1. Set to 0 to disable. (default: 0.005)
--color-swap-chance (0 <= float(n) <= 1)
Probability of swapping a character's color on each tick, from 0 to 1. Set to 0 to disable. (default: 0.001)
--resolve-delay (int > 0)
Number of frames to wait between resolving the next group of characters. This is used to adjust the speed of the
final resolve phase. (default: 3)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 92be92 336b33)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 3)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: radial)
Example: terminaltexteffects matrix --highlight-color dbffdb --rain-color-gradient 92be92 185318 --rain-symbols 2 5 9 8 Z '*' ')' : . '"' = + - ¦ '|' _ ｦ ｱ ｳ ｴ ｵ ｶ ｷ ｹ ｺ ｻ ｼ ｽ ｾ ｿ ﾀ ﾁ ﾂ ﾃ ﾄ ﾅ ﾆ ﾇ ﾈ ﾉ ﾊ ﾋ ﾌ ﾍ ﾎ ﾏ ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾖ ﾗ ﾘ ﾙ ﾚ ﾛ ﾜ ﾝ ﾞ ﾟ --rain-fall-delay-range 2-15 --rain-column-delay-range 3-9 --rain-time 15 --symbol-swap-chance 0.005 --color-swap-chance 0.001 --resolve-delay 3 --final-gradient-stops 92be92 336b33 --final-gradient-steps 12 --final-gradient-frames 3 --final-gradient-direction radial
MiddleOut
Text expands in a single row or column in the middle of the canvas then out.
MiddleOut Command Line Arguments
--starting-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the initial text in the center of the canvas. (default: ffffff)
--expand-direction {vertical,horizontal}
Direction the text will expand. (default: vertical)
--center-movement-speed (float > 0)
Speed of the characters during the initial expansion of the center vertical/horiztonal line. (default: 0.6)
--full-movement-speed (float > 0)
Speed of the characters during the final full expansion. (default: 0.6)
--center-easing CENTER_EASING
Easing function to use for initial expansion. (default: in_out_sine)
--full-easing FULL_EASING
Easing function to use for full expansion. (default: in_out_sine)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects middleout --starting-color ffffff --expand-direction vertical --center-movement-speed 0.6 --full-movement-speed 0.6 --center-easing IN_OUT_SINE --full-easing IN_OUT_SINE --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction vertical
OrbittingVolley
Four launchers travel along the canvas edges, firing characters from their nearest canvas side to build the text in expanding circular rings. Rings launch in order with up to two still in flight.
OrbittingVolley Command Line Arguments
--top-launcher-symbol (ASCII/UTF-8 character)
Symbol for the top launcher. (default: █)
--right-launcher-symbol (ASCII/UTF-8 character)
Symbol for the right launcher. (default: █)
--bottom-launcher-symbol (ASCII/UTF-8 character)
Symbol for the bottom launcher. (default: █)
--left-launcher-symbol (ASCII/UTF-8 character)
Symbol for the left launcher. (default: █)
--launcher-movement-speed (float > 0)
Orbitting speed of the launchers. (default: 0.8)
--character-movement-speed (float > 0)
Speed of the launched characters. (default: 1.5)
--volley-size (0 <= float(n) <= 1)
Fraction of input characters used to set the volley limit, divided among four launchers, from 0 to 1. Each
launcher fires at least one character when available, limited to its share of the active circular ring.
(default: 0.03)
--launch-delay (int >= 0)
Number of animation ticks to wait between volleys of characters. (default: 1)
--character-easing (Easing Function)
Easing function to use for launched character movement. (default: out_sine)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ffa15c 44d492)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: radial)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects orbittingvolley --top-launcher-symbol █ --right-launcher-symbol █ --bottom-launcher-symbol █ --left-launcher-symbol █ --launcher-movement-speed 0.8 --character-movement-speed 1.5 --volley-size 0.03 --launch-delay 1 --character-easing OUT_SINE --final-gradient-stops FFA15C 44D492 --final-gradient-steps 12 --final-gradient-direction radial
Overflow
Input text overflows and scrolls the terminal in a random order until eventually appearing ordered.
Overflow Command Line Arguments
--overflow-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the overflow gradient. (default: f2ebc0 8dbfb3 f2ebc0)
--overflow-cycles-range (hyphen separated non-negative int range e.g. '0-4')
Inclusive range of overflow cycle counts. Use 0-0 to disable overflow cycles. (default: 2 4)
--overflow-speed (int > 0)
Speed of the overflow effect. (default: 3)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects overflow --final-gradient-stops 8A008A 00D1FF FFFFFF --final-gradient-steps 12 --final-gradient-direction vertical --overflow-gradient-stops f2ebc0 8dbfb3 f2ebc0 --overflow-cycles-range 2-4 --overflow-speed 3
Pour
Pours the characters back and forth from the top, bottom, left, or right.
Pour Command Line Arguments
--pour-direction {up,down,left,right}
Direction the text will pour. (default: down)
--pour-speed (int > 0)
Number of characters poured in per tick. Increase to speed up the effect. (default: 2)
--movement-speed-range (float > 0)
Movement speed range of the characters. (default: 0.4-0.6)
--gap (int >= 0)
Number of frames to wait between each character in the pour effect. Increase to slow down effect and create a
more defined back and forth motion. (default: 1)
--starting-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color of the characters before the gradient starts. (default: ffffff)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 6)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
--movement-easing MOVEMENT_EASING
Easing function to use for character movement. (default: in_quad)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects pour --pour-direction down --pour-speed 2 --movement-speed-range 0.4-0.6 --gap 1 --starting-color ffffff --movement-easing IN_QUAD --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-frames 6 --final-gradient-direction vertical
Prints the input data one line at at time with a carriage return and line feed.
Print Command Line Arguments
--print-head-return-speed (float > 0)
Speed of the print head when performing a carriage return. (default: 1.5)
--print-speed (int > 0)
Speed of the print head when printing characters. (default: 2)
--print-head-easing PRINT_HEAD_EASING
Easing function to use for print head movement. (default: in_out_quad)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 02b8bd c1f0e3 00ffa0)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects print --final-gradient-stops 02b8bd c1f0e3 00ffa0 --final-gradient-steps 12 --final-gradient-direction diagonal --print-head-return-speed 1.5 --print-speed 2 --print-head-easing IN_OUT_QUAD
Rain
Rain characters from the top of the canvas.
Rain Command Line Arguments
--rain-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
List of colors for the rain drops. Colors are randomly chosen from the list. (default: 00315c 004c8f 0075db
3f91d9 78b9f2 9ac8f5 b8d8f8 e3effc)
--movement-speed (hyphen separated float range e.g. '0.25-0.5')
Falling speed range of the rain drops. (default: 0.33-0.57)
--rain-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated list of symbols to use for the rain drops. Symbols are randomly chosen from the list. (default:
o . , * |)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 488bff b2e7de 57eaf7)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
--movement-easing (Easing Function)
Easing function to use for character movement. (default: in_quart)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects rain --rain-symbols o . , '*' '|' --rain-colors 00315C 004C8F 0075DB 3F91D9 78B9F2 9AC8F5 B8D8F8 E3EFFC --movement-speed 0.33-0.57 --movement-easing IN_QUART --final-gradient-stops 488bff b2e7de 57eaf7 --final-gradient-steps 12 --final-gradient-direction diagonal
RandomSequence
Prints the input data in a random sequence, one character at a time.
RandomSequence Command Line Arguments
--speed (0 < float(n) <= 1)
Fraction of input characters to reveal per tick. Values must be greater than 0 and at most 1. (default: 0.007)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 8)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects randomsequence --speed 0.007 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-frames 8 --final-gradient-direction vertical
Rings
Characters are dispersed and form into spinning rings.
Rings Command Line Arguments
--ring-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the rings. (default: ab48ff e7b2b2 fffebd)
--ring-gap (0 < float(n) <= 1)
Distance between rings as a fraction of the smallest canvas dimension, greater than 0 and at most 1. (default:
0.1)
--spin-duration (int >= 0)
Number of frames for each cycle of the spin phase. (default: 200)
--spin-speed (hyphen separated float range e.g. '0.25-0.5')
Range of speeds for the rotation of the rings. The speed is randomly selected from this range for each ring.
(default: 0.25-1.0)
--disperse-duration (int >= 0)
Number of frames to hold the dispersed state between spinning cycles. Use 0 for no added hold. (default: 200)
--spin-disperse-cycles SPIN_DISPERSE_CYCLES
Number of times the animation will cycles between spinning rings and dispersed characters. (default: 3)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ab48ff e7b2b2 fffebd)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects rings --ring-colors ab48ff e7b2b2 fffebd --final-gradient-stops ab48ff e7b2b2 fffebd --final-gradient-steps 12 --final-gradient-direction vertical --ring-gap 0.1 --spin-duration 200 --spin-speed 0.25-1.0 --disperse-duration 200 --spin-disperse-cycles 3
Scattered
Text is scattered across the canvas and moves into position.
Scattered Command Line Arguments
--movement-speed (float > 0)
Movement speed of the characters. (default: 0.5)
--movement-easing MOVEMENT_EASING
Easing function to use for character movement. (default: in_out_back)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ff9048 ab9dff bdffea)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 9)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects scattered --final-gradient-stops ff9048 ab9dff bdffea --final-gradient-steps 12 --final-gradient-frames 9 --final-gradient-direction vertical --movement-speed 0.5 --movement-easing IN_OUT_BACK
Slice
Slices the input in half and slides it into place from opposite directions.
Slice Command Line Arguments
--slice-direction {vertical,horizontal,diagonal}
Direction of the slice. (default: vertical)
--movement-speed (float > 0)
Movement speed of the characters. (default: 0.25)
--movement-easing MOVEMENT_EASING
Easing function to use for character movement. (default: in_out_expo)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects slice --final-gradient-stops 8A008A 00D1FF FFFFFF --final-gradient-steps 12 --slice-direction vertical --movement-speed 0.15 --movement-easing IN_OUT_EXPO
Slide
Slide characters into view from outside the terminal.
Slide Command Line Arguments
--movement-speed (float > 0)
Speed of the characters. (default: 0.8)
--grouping {row,column,diagonal}
Direction to group characters. (default: row)
--gap (int >= 0)
Number of frames to wait before adding the next group of characters. Increasing this value creates a more
staggered effect. (default: 2)
--reverse-direction
Reverse the direction of the characters. (default: False)
--merge
Merge the character groups originating from either side of the terminal. (--reverse-direction is ignored when
merging) (default: False)
--movement-easing (Easing Function)
Easing function to use for character movement. (default: in_out_quad)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 833ab4 fd1d1d fcb045)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 6)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects slide --movement-speed 0.8 --grouping row --gap 2 [--reverse-direction] [--merge] --movement-easing IN_OUT_QUAD --final-gradient-stops 833ab4 fd1d1d fcb045 --final-gradient-steps 12 --final-gradient-frames 6 --final-gradient-direction vertical
Smoke
Smoke floods the canvas colorizing any characters it crosses.
Smoke Command Line Arguments
--starting-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color of the text before being colorized by the smoke. (default: 7a7a7a)
--smoke-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Symbols to use for the smoke. Strings will be used in sequence to create an animation. (default: ░ ▒ ▓ ▒ ░)
--smoke-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the smoke gradient. Smoke will transition through this gradient
before moving through the final gradient stops. (default: 242424 ffffff)
--use-whole-canvas
If True, the entire canvas will be flooded. Otherwise the effect is limited to the text boundary. (default:
False)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects smoke --starting-color 7A7A7A --smoke-symbols ░ ▒ ▓ ▒ ░ --smoke-gradient-stops 242424 ffffff [--use-whole-canvas] --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction vertical
Spotlights
Spotlights search the text area, illuminating characters, before converging in the center and expanding.
Spotlights Command Line Arguments
--beam-width-ratio (float > 0)
Width of the beam of light as min(width, height) // n of the input text. Values less than 1 are raised to 1.
(default: 2.0)
--beam-falloff (0 <= float(n) <= 1)
Distance from the edge of the beam where the brightness begins to fall off, as a percentage of total beam width.
Valid values are 0 <= n <= 1. (default: 0.3)
--search-duration (int > 0)
Duration of the search phase, in frames, before the spotlights converge in the center. (default: 550)
--search-speed-range (hyphen separated float range e.g. '0.25-0.5')
Range of speeds for the spotlights during the search phase. The speed is a random value between the two provided
values. (default: 0.35-0.75)
--spotlight-count (int > 0)
Number of spotlights to use. (default: 3)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ab48ff e7b2b2 fffebd)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects spotlights --final-gradient-stops ab48ff e7b2b2 fffebd --final-gradient-steps 12 --final-gradient-direction vertical --beam-width-ratio 2.0 --beam-falloff 0.3 --search-duration 550 --search-speed-range 0.35-0.75 --spotlight-count 3
Spray
Sprays the characters from a single point.
Spray Command Line Arguments
--spray-position {n,ne,e,se,s,sw,w,nw,center}
Position for the spray origin. (default: e)
--spray-volume (0 < float(n) <= 1)
Number of characters to spray per tick as a percent of the total number of characters. (default: 0.005)
--movement-speed-range (hyphen separated float range e.g. '0.25-0.5')
Movement speed range of the characters. (default: 0.6-1.4)
--movement-easing MOVEMENT_EASING
Easing function to use for character movement. (default: out_expo)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects spray --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction vertical --spray-position e --spray-volume 0.005 --movement-speed-range 0.6-1.4 --movement-easing OUT_EXPO
Swarm
Characters are grouped into swarms and move around the terminal before settling into position.
Swarm Command Line Arguments
--base-color (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the swarms (default: 31a0d4)
--flash-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the character flash. Characters flash when moving. (default: f2ea79)
--swarm-size (0 <= float(n) <= 1)
Percent of total characters in each swarm. Zero uses one character per swarm. (default: 0.1)
--swarm-coordination (0 <= float(n) <= 1)
Percent of characters in a swarm that move as a group. Zero disables coordinated followers. (default: 0.8)
--swarm-area-count-range (hyphen separated positive int range e.g. '1-10')
Range of the number of areas where characters will swarm. (default: 2-4)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 31b900 f0ff65)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: horizontal)
Example: terminaltexteffects swarm --base-color 31a0d4 --flash-color f2ea79 --final-gradient-stops 31b900 f0ff65 --final-gradient-steps 12 --final-gradient-direction horizontal --swarm-size 0.1 --swarm-coordination 0.8 --swarm-area-count-range 2-4
Sweep
Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.
Sweep Command Line Arguments
--sweep-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated list of symbols to use for the sweep shimmer. (default: █ ▓ ▒ ░)
--first-sweep-direction column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Grouping or character sort order for the first sweep, revealing uncolored characters. (default:
column_right_to_left)
--reverse-first-sweep-direction
Reverse the complete first sweep direction traversal. (default: False)
--second-sweep-direction column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Grouping or character sort order for the second sweep, coloring the characters. (default: column_left_to_right)
--reverse-second-sweep-direction
Reverse the complete second sweep direction traversal. (default: False)
--travel-speed (int > 0)
Number of sweep easing steps to advance per frame, for both phases. n > 0. (default: 1)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied from bottom to top). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 8)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects sweep --sweep-symbols '█' '▓' '▒' '░' --first-sweep-direction column_right_to_left --second-sweep-direction column_left_to_right --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 8 --final-gradient-direction vertical
SynthGrid
Create a grid of balanced, approximately square cells which fill with characters dissolving into the final text. Cell sizes differ by at most one position in each dimension. Tiny canvases use fewer cells and omit grid decoration where needed, supporting canvases down to a single character.
SynthGrid Command Line Arguments
--grid-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the grid gradient. (default: cc00cc ffffff)
--grid-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--grid-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the gradient for the grid color. (default: diagonal)
--text-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the text gradient. (default: 8a008a 00d1ff ffffff)
--text-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--text-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the gradient for the text color. (default: vertical)
--grid-row-symbol (ASCII/UTF-8 character)
Symbol to use for grid row lines. (default: ─)
--grid-column-symbol (ASCII/UTF-8 character)
Symbol to use for grid column lines. (default: │)
--text-generation-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated, unquoted, list of characters for the text generation animation. (default: ░ ▒ ▓)
--max-active-blocks (0 < float(n) <= 1)
Maximum percentage of blocks to have active at any given time. For example, if set to 0.1, 10 percent of the
blocks will be active at any given time. (default: 0.1)
Example: terminaltexteffects synthgrid --grid-gradient-stops CC00CC ffffff --grid-gradient-steps 12 --grid-gradient-direction diagonal --text-gradient-stops 8A008A 00D1FF ffffff --text-gradient-steps 12 --text-gradient-direction vertical --grid-row-symbol ─ --grid-column-symbol │ --text-generation-symbols ░ ▒ ▓ --max-active-blocks 0.1
Thunderstorm
Create a thunderstorm in the terminal.
Thunderstorm Command Line Arguments
--lightning-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the lightning strike. (default: 68a3e8)
--glowing-text-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the text when glowing after a lightning strike. (default: ef5411)
--text-glow-time (int > 0)
Number of frames to display each color in the post-lightning text glow cooling gradient. Increase to slow down
the cooling animation. (default: 6)
--raindrop-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Symbols to use for the raindrops. (default: \ . ,)
--spark-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Symbols to use for the lightning impact sparks. (default: * . ')
--spark-glow-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color for the spark glow after a lightning strike. (default: ff4d00)
--spark-glow-time (int > 0)
Number of frames to display each color in the post-lightning spark cooling gradient. Increase to slow down the
cooling animation. (default: 18)
--storm-time (float > 0)
Duration, in seconds, the storm will occur. (default: 12)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 3)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
terminaltexteffects thunderstorm --lightning-color 68A3E8 --glowing-text-color EF5411 --text-glow-time 6 --raindrop-symbols '\\' '.' ',' --spark-symbols '*' '.' "'" --spark-glow-color ff4d00 --spark-glow-time 18 --storm-time 12 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-frames 3 --final-gradient-direction vertical
Unstable
Spawns characters jumbled, explodes them to the edge of the canvas, then reassembles them.
Unstable Command Line Arguments
--unstable-color (XTerm [0-255] OR RGB Hex [000000-ffffff])
Color transitioned to as the characters become unstable. (default: ff9200)
--explosion-ease EXPLOSION_EASE
Easing function to use for character movement during the explosion. (default: out_expo)
--explosion-speed (float > 0)
Speed of characters during explosion. (default: 1)
--reassembly-ease REASSEMBLY_EASE
Easing function to use for character reassembly. (default: out_expo)
--reassembly-speed (float > 0)
Speed of characters during reassembly. (default: 1)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: 8a008a 00d1ff ffffff)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects unstable --unstable-color ff9200 --explosion-ease OUT_EXPO --explosion-speed 1 --reassembly-ease OUT_EXPO --reassembly-speed 1 --final-gradient-stops 8A008A 00D1FF ffffff --final-gradient-steps 12 --final-gradient-direction vertical
VHSTape
Lines of characters glitch left and right and lose detail like an old VHS tape.
VHSTape Command Line Arguments
--glitch-line-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the characters when a single line is glitching. Colors are applied
in order as an animation. (default: ffffff ff0000 00ff00 0000ff ffffff)
--glitch-wave-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the characters in lines that are part of the glitch wave. Colors
are applied in order as an animation. (default: ffffff ff0000 00ff00 0000ff ffffff)
--noise-colors (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the characters during the noise phase. (default: 1e1e1f 3c3b3d
6d6c70 a2a1a6 cbc9cf ffffff)
--glitch-line-chance (0 <= float(n) <= 1)
Chance that a line will glitch on any given frame. (default: 0.05)
--noise-chance (0 <= float(n) <= 1)
Chance that all characters will experience noise on any given frame. (default: 0.004)
--total-glitch-time (int > 0)
Total time, frames, that the glitching phase will last. (default: 600)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ab48ff e7b2b2 fffebd)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Example: terminaltexteffects vhstape --final-gradient-stops ab48ff e7b2b2 fffebd --final-gradient-steps 12 --final-gradient-direction vertical --glitch-line-colors ffffff ff0000 00ff00 0000ff ffffff --glitch-wave-colors ffffff ff0000 00ff00 0000ff ffffff --noise-colors 1e1e1f 3c3b3d 6d6c70 a2a1a6 cbc9cf ffffff --glitch-line-chance 0.05 --noise-chance 0.004 --total-glitch-time 600
Waves
Waves travel across the terminal leaving behind the characters.
Waves Command Line Arguments
--wave-symbols (ASCII/UTF-8 character) [(ASCII/UTF-8 character) ...]
Space separated, individually printable symbols to use in sequence for the wave animation. (default: ▁ ▂ ▃ ▄ ▅ ▆
▇ █ ▇ ▆ ▅ ▄ ▃ ▂ ▁)
--wave-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the animated wave gradient. If only one color is provided, the
characters will be displayed in that color. (default: f0ff65 ffb102 31a0d4 ffb102 f0ff65)
--wave-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 6)
--wave-count WAVE_COUNT
Number of waves to generate. n > 0. (default: 7)
--wave-length (int > 0)
The number of frames for each step of the wave. Higher wave-lengths will create a slower wave. (default: 2)
--wave-direction column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Character order for wave activation; spatial groups or individual characters, including spirals. (default:
circle_center_to_outside)
--reverse-wave-direction
Reverse the complete wave direction traversal. (default: False)
--travel-speed (int > 0)
Number of ordered entries to activate per frame: whole spatial groups or individual characters. n > 0. (default:
1)
--wave-easing WAVE_EASING
Easing function to use for wave travel. (default: in_out_sine)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one
color is provided, the characters will be displayed in that color. (default: ffb102 31a0d4 f0ff65)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: diagonal)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects waves --wave-symbols ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▇ ▆ ▅ ▄ ▃ ▂ ▁ --wave-gradient-stops f0ff65 ffb102 31a0d4 ffb102 f0ff65 --wave-gradient-steps 6 --wave-count 7 --wave-length 2 --wave-direction circle_center_to_outside --wave-easing IN_OUT_SINE --final-gradient-stops ffb102 31a0d4 f0ff65 --final-gradient-steps 12 --final-gradient-direction diagonal
Wipe
Performs a wipe across the terminal to reveal characters.
Wipe Command Line Arguments
--wipe-direction column_left_to_right column_right_to_left row_top_to_bottom row_bottom_to_top diagonal_top_left_to_bottom_right diagonal_bottom_left_to_top_right diagonal_top_right_to_bottom_left diagonal_bottom_right_to_top_left diamonds_center_to_outside diamonds_outside_to_center circle_center_to_outside circle_outside_to_center random top_to_bottom_left_to_right top_to_bottom_right_to_left bottom_to_top_left_to_right bottom_to_top_right_to_left outside_row_to_middle middle_row_to_outside spiral_clockwise spiral_counter_clockwise spiral_clockwise_double spiral_counter_clockwise_double spiral_clockwise_quad spiral_counter_clockwise_quad
Character order for the wipe: spatial groups or individual traversal, including spirals. (default:
diagonal_top_left_to_bottom_right)
--reverse-wipe-direction
Reverse the complete wipe direction traversal. (default: False)
--wipe-delay (int >= 0)
Number of frames to wait between wipe easing steps. Increase to slow down the effect. (default: 0)
--wipe-ease WIPE_EASE
Easing function to use for the wipe effect. (default: in_out_circ)
--final-gradient-stops (XTerm [0-255] OR RGB Hex [000000-ffffff]) [(XTerm [0-255] OR RGB Hex [000000-ffffff]) ...]
Space separated, unquoted, list of colors for the wipe gradient. (default: 833ab4 fd1d1d fcb045)
--final-gradient-steps (int > 0) [(int > 0) ...]
Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and
longer gradient animation. (default: 12)
--final-gradient-frames (int > 0)
Number of frames to display each gradient step. Increase to slow down the gradient animation. (default: 3)
--final-gradient-direction (diagonal, horizontal, vertical, radial)
Direction of the final gradient across the text. (default: vertical)
Easing
------
Note: A prefix must be added to the function name (except LINEAR).
All easing functions support the following prefixes:
IN_ - Ease in
OUT_ - Ease out
IN_OUT_ - Ease in and out
Easing Functions
----------------
LINEAR - Linear easing
SINE - Sine easing
QUAD - Quadratic easing
CUBIC - Cubic easing
QUART - Quartic easing
QUINT - Quintic easing
EXPO - Exponential easing
CIRC - Circular easing
BACK - Back easing
ELASTIC - Elastic easing
BOUNCE - Bounce easing
Visit: https://easings.net/ for visualizations of the easing functions.
Example: terminaltexteffects wipe --wipe-direction diagonal_top_left_to_bottom_right --wipe-delay 0 --wipe-ease IN_OUT_CIRC --final-gradient-stops 833ab4 fd1d1d fcb045 --final-gradient-steps 12 --final-gradient-frames 3 --final-gradient-direction vertical