1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
# Intro to TTE
## What is TTE?
TerminalTextEffects (TTE) is a terminal visual effects engine. TTE can be installed as a system application to produce effects in your terminal, or as a Python library to enable effects within your Python scripts/applications. TTE includes a growing library of built-in effects which showcase the engine's features. These features include:
* Xterm 256 / RGB hex color support
* Complex character movement via Paths, Waypoints, and
motion easing, with support for quadratic/cubic bezier curves.
* Complex animations via Scenes with symbol/color changes,
layers, easing, and Path synced progression.
* Variable stop/step color gradient generation.
* Event handling for Path/Scene state changes with
custom callback support and many pre-defined actions.
* Effect customization exposed through a typed effect configuration
dataclass that is automatically handled as CLI arguments.
* Runs inline, preserving terminal state and workflow.
## Getting Started
TTE can be used as a system application or as a Python library. To get started, visit the installation and usage guides below.
[Installation Guide](./installation.md){ .md-button } [Application Usage](./appguide.md){ .md-button } [Library Usage](./libguide.md){ .md-button }
## Effects Library
TTE includes a growing library of built-in effects. Visit the showroom to see examples of each effect.
[Effects Showroom](./showroom.md){ .md-button }
## Library Cookbook
Check out the cookbook to see interesting examples using the TTE library.
[Library Cookbook](./cookbook.md){ .md-button }
## Release Write-Ups
Friendly release write-ups can be found in the [ChangeBlog](./changeblog/changeblog.md)
[ChangeBlog](./changeblog/changeblog.md){ .md-button }
|
