terminaltexteffects 0.2.0

A collection of visual effects that can be applied to terminal piped stdin text.

Terminal Text Effects

Inline Visual Effects in the Terminal

Table Of Contents

• About
• Requirements
• Installation
• Usage
• Options
• Examples
• License

TTE

TerminalTextEffects is a collection of visual effects that run inline in the terminal. The underlying visual effect framework supports the following:

• XTerm 256 Color
• RGB Hex Triplet Color
• Color Gradients
• Character Motion (Waypoints, Speed, Acceleration)
• UTF8 Character Set

Requirements

TerminalTextEffects is written in Python and does not require any 3rd party modules. Terminal interactions use standard ANSI terminal sequences and should work in most modern terminals.

Installation

pip install terminaltexteffects

Usage

cat your_text | tte <effect> [options]

OR

cat your_text | python -m terminaltexteffects <effect> [options]

• All effects support adjustable animation speed using the -a option.
• Use <effect> -h to view options for a specific effect, such as color or movement direction.
  • Ex: tte decrypt -h

Options

options:
  -h, --help            show this help message and exit
  --xterm-colors        Convert any colors specified in RBG hex to the closest XTerm-256 color.

Effect:
  Name of the effect to apply. Use <effect> -h for effect specific help.

  {burn,columnslide,decrypt,expand,pour,rain,randomsequence,rowmerge,rowslide,scattered,shootingstar,spray,verticalslice}
                        Available Effects
    burn                Burns vertically in the output area.
    columnslide         Slides each column into place.
    decrypt             Display a movie style decryption effect.
    expand              Expands the text from a single point.
    pour                Pours the characters into position from the given direction.
    rain                Rain characters from the top of the output area.
    randomsequence      Prints the input data in a random sequence.
    rowmerge            Merges rows of characters.
    rowslide            Slides each row into place.
    scattered           Move the characters into place from random starting locations.
    shootingstar        Displays the text as a falling star toward the final coordinate of the character.
    spray               Draws the characters spawning at varying rates from a single point.
    verticalslice       Slices the input in half vertically and slides it into place from opposite directions.

Examples

RAIN

DECRYPT

BURN

ROWSLIDE

EXPAND

License

Distributed under the MIT License. See LICENSE for more information.