A collection of visual effects that can be applied to terminal piped stdin text.
Project description
Terminal Text Effects
Inline Visual Effects in the Terminal
Table Of Contents
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 and RBG hex color support
- Color gradients
- Runs inline, preserving terminal state and workflow
- Dynamic character movement with motion easing
- Dynamic animations with symbol and color changes
- Effect customization through command line arguments
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.
Note: Windows Terminal performance is slow for some effects.
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
- Ex:
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.
--no-color Disable all colors in the effect.
--tab-width TAB_WIDTH
Number of spaces to use for a tab character.
--no-wrap Disable wrapping of text.
Effect:
Name of the effect to apply. Use <effect> -h for effect specific help.
{bouncyballs,bubbles,burn,columnslide,decrypt,expand,fireworks,pour,rain,randomsequence,rowmerge,rowslide,scattered,spray,unstable,verticalslice}
Available Effects
bouncyballs Characters are bouncy balls falling from the top of the output area.
bubbles Characters are formed into bubbles that float down and pop.
burn Burns vertically in the output area.
columnslide Slides each column into place from the outside to the middle.
decrypt Display a movie style decryption effect.
expand Expands the text from a single point.
fireworks Characters launch and explode like fireworks and fall into place.
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.
spray Draws the characters spawning at varying rates from a single point.
unstable Spawn characters jumbled, explode them to the edge of the output area, then reassemble them in the correct layout.
verticalslice Slices the input in half vertically and slides it into place from opposite directions.
Examples
Fireworks
RAIN
DECRYPT
SPRAY
SCATTERED
EXPAND
BURN
POUR
ROWSLIDE
ROWMERGE
COLUMNSLIDE
RANDOMSEQUENCE
VERTICALSLICE
In-Development Preview
Any effects shown below are in development and will be available in the next release.
Unstable
Bubbles
Bouncyballs
Middleout
License
Distributed under the MIT License. See LICENSE for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for terminaltexteffects-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bcdc36f8e6e8bb3bffb5eaa20489ed270ed8952a97e4151cc23789877f55a45 |
|
MD5 | 2c9da85b9a61fc3cc8dc7358192ab743 |
|
BLAKE2b-256 | 38ae4cd4af05b8478ca48134eba08051c43d258ac7008c148874f25b94779f4e |
Hashes for terminaltexteffects-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf9e5b38ad253da2515eb9e8d486a008e30c0160f7a31875d179b7ab699c13b1 |
|
MD5 | b8c9ced77ed2de416cfbf896fc8705e8 |
|
BLAKE2b-256 | 9cbde2030e96af4028f99506801bfd7d91e2b1e3148331446c5c84a4a5f7a1ef |