terminaltexteffects

<br/> <p align="center"> <a href="https://github.com/ChrisBuilds/terminaltexteffects"> <img src="https://github.com/ChrisBuilds/terminaltexteffects/assets/57874186/66388e57-e95e-4619-b804-1d8d7ebd124f" alt="TTE" width="80" height="80"> </a> <h3 align="center">终端文本效果</h3> <p align="center"> 终端内的内联视觉效果 <br/> <br/> </p> </p>

PyPI - Python 版本许可证

TTE

synthgrid_demo

TerminalTextEffects（TTE）是一个终端视觉效果引擎。TTE 可以作为系统应用程序安装以在终端中产生效果，或作为 Python 库安装以在 Python 脚本/应用程序中启用效果。TTE 包含一个不断增长的内置效果库，展示了引擎的特性。这些特性包括：

支持 Xterm 256 / RGB 十六进制颜色
通过路径、航点和运动缓动实现复杂的字符移动，支持二次/三次贝塞尔曲线
通过场景实现复杂动画，包括符号/颜色变化、图层、缓动和与路径同步的进展
可变停止/步进颜色渐变生成
处理路径/场景状态变化的事件，支持自定义回调和多种预定义动作
通过类型化的效果配置数据类暴露效果自定义选项，自动处理为命令行参数
内联运行，保留终端状态和工作流

要求

TerminalTextEffects 使用 Python 编写，不需要任何第三方模块。终端交互使用标准 ANSI 终端序列，应该可以在大多数现代终端中正常工作。

注意：Windows 终端对某些效果的性能较慢。

安装

pip install terminaltexteffects 或 pipx install terminaltexteffects

Nix（flakes）

将其作为输入添加到 flake 中：

inputs = {
  terminaltexteffects.url = "github:ChrisBuilds/terminaltexteffects/<可选-引用>"
}

创建一个包含它的 shell：

nix shell github:ChrisBuilds/terminaltexteffects/<可选-引用>

或直接运行：

echo 'terminaltexteffects is awesome' | nix run github:ChrisBuilds/terminaltexteffects/<可选-引用> -- beams

Nix（经典）

获取源代码并添加到您的 shell 中，例如：

let
  pkgs = import <nixpkgs> {};

  tte = pkgs.callPackage (pkgs.fetchFromGitHub {
    owner = "ChrisBuilds";
    repo = "terminaltexteffects";
    rev = "<版本，例如 main/v0.10.0/等>";
    hash = ""; # 先构建，然后填入正确的哈希值
  }) {};
in
  pkgs.mkShell {
    packages = [tte];
  }

使用

查看文档获取完整的安装和使用指南。

应用程序快速入门

选项

<details> <summary>TTE 命令行选项</summary>

  选项:
  -h, --help            显示此帮助消息并退出
  --input-file INPUT_FILE, -i INPUT_FILE
                        从文件读取输入（默认：无）
  --version, -v         显示程序的版本号并退出
  --tab-width (int > 0)
                        用于制表符的空格数。（默认：4）
  --xterm-colors        将任何以 RGB 十六进制指定的颜色转换为最接近的
                        XTerm-256 颜色。（默认：False）
  --no-color            禁用效果中的所有颜色。（默认：False）
  --wrap-text           换行宽度超过画布宽度的文本。（默认：False）
  --frame-rate FRAME_RATE
                        动画的目标帧率。（默认：100）
  --canvas-width WIDTH  画布宽度，设置为大于 0 的整数以使用特定
                        尺寸，或使用 0 或 -1 分别基于输入数据或终端设备
                        设置尺寸。（默认：-1）
  --canvas-height WIDTH
                        画布高度，设置为大于 0 的整数以使用特定
                        尺寸，或使用 0 或 -1 分别基于输入数据或终端设备
                        设置尺寸。（默认：-1）
  --anchor-canvas {sw,s,se,e,ne,n,nw,w,c}
                        画布的锚点。画布将锚定在终端中
                        对应于基本/对角方向的位置。（默认：sw）
  --anchor-text {n,ne,e,se,s,sw,w,nw,c}
                        画布内文本的锚点。输入文本将锚定在画布中
                        对应于基本/对角方向的位置。（默认：sw）
  --ignore-terminal-dimensions
                        忽略终端尺寸并利用超出终端范围的整个画布。
                        用于将帧发送到其他输出处理程序。（默认：False）

  效果:
  要应用的效果名称。使用 <效果> -h 获取特定效果的帮助。

  {beams,binarypath,blackhole,bouncyballs,bubbles,burn,canvas_test,colorshift,crumble,decrypt,dev,errorcorrect,expand,fireworks,matrix,middleout,orbittingvolley,overflow,pour,print,rain,randomsequence,rings,scattered,slice,slide,spotlights,spray,swarm,synthgrid,test,unstable,vhstape,waves,wipe}
                        可用效果
    beams               创建在画布上移动的光束，照亮它们背后的字符。
    binarypath          每个字符的二进制表示在终端中向字符的原始坐标移动。
    blackhole           字符被黑洞吞噬并向外爆炸。
    bouncyballs         字符是从画布顶部落下的弹力球。
    bubbles             字符形成向下漂浮并破裂的气泡。
    burn                在画布中垂直燃烧。
    colorshift          显示在终端中移动的颜色渐变。
    crumble             字符失去颜色并碎裂成灰尘，被吸走，然后重新组合。
    decrypt             显示电影风格的解密效果。
    errorcorrect        一些字符开始时位置错误，然后按顺序纠正。
    expand              从单一点扩展文本。
    fireworks           字符像烟花一样发射并爆炸，然后落入正确位置。
    matrix              矩阵数字雨效果。
    middleout           文本从画布中间的单行或单列开始扩展，然后向外扩展。
    orbittingvolley     四个发射器围绕画布旋转，向内发射字符弹幕，从中心向外构建输入文本。
    overflow            输入文本溢出并以随机顺序滚动终端，最终按顺序显示。
    pour                从给定方向将字符倒入正确位置。
    print               按照打印头逐行打印。打印头执行换行和回车。
    rain                从画布顶部下雨字符。
    randomsequence      以随机顺序打印输入数据。
    rings               字符分散并形成旋转的环。
    scattered           文本散布在画布上并移动到正确位置。
    slice               将输入切成两半，从相反方向滑入正确位置。
    slide               从终端外滑动字符进入视图。
    spotlights          聚光灯搜索文本区域，照亮字符，然后汇聚到中心并扩展。
    spray               从单一点以不同速率生成字符。
    swarm               字符分组成群，在终端中移动，然后定位到正确位置。
    synthgrid           创建一个网格，填充字符，然后溶解成最终文本。
    unstable            生成混乱的字符，将它们炸到画布边缘，然后重新组合成正确的布局。
    vhstape             字符行左右抖动并失去细节，像旧 VHS 磁带一样。
    waves               波浪穿过终端，留下字符。
    wipe                在终端中擦拭文本以显示字符。
    
  示例：ls -a | python -m terminaltexteffects decrypt --typing-speed 2 --ciphertext-colors 008000 00cb00 00ff00 --final-gradient-stops eda000 --final-gradient-steps 12 --final-gradient-direction vertical

</details>

cat 你的文本 | tte <效果> [选项]

或

cat 你的文本 | python -m terminaltexteffects <效果> [选项]

使用 <效果> -h 查看特定效果的选项，如颜色或移动方向。
- 例如：tte decrypt -h

获取更多信息，请查看应用程序使用指南。

库快速入门

所有效果都是迭代器，返回表示当前帧的字符串。基本用法就像导入效果、用输入文本实例化它并遍历效果一样简单。

from terminaltexteffects.effects import effect_rain

effect = effect_rain.Rain("你的文本在这里")

for frame in effect:
    # 对字符串进行操作
    ...

如果你想让 TTE 处理终端的设置/拆卸、光标定位和动画帧率，可以使用 terminal_output() 上下文管理器。

from terminaltexteffects.effects import effect_rain

effect = effect_rain.Rain("你的文本在这里")
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)