Project Icon

terminaltexteffects

为终端应用添加动态视觉效果的开源工具

Terminal Text Effects是一个开源的终端视觉效果引擎,既可作为独立应用程序使用,也可作为Python库集成。它支持256色/RGB颜色显示,实现复杂的字符移动和动画效果,以及渐变色生成等功能。该项目内置多种视觉效果,如光束、二进制路径、黑洞等,能够为终端界面带来丰富的视觉体验。Terminal Text Effects采用内联运行方式,可保留原有终端状态和工作流程,是为终端应用增添动态效果的实用工具。


TTE

终端文本效果

终端内的内联视觉效果

PyPI - 版本 PyPI - Python 版本 Python Bytes 许可证

目录

TTE

synthgrid_demo

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

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

要求

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

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

安装

pip install terminaltexteffectspipx 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];
  }

使用

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

应用程序快速入门

选项

TTE 命令行选项
  选项:
  -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

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)

获取更多信息,请查看库使用指南

效果展示

注意:以下是内置效果的一部分。

效果展示厅中查看所有效果及相关信息。

光束

beams_demo

二进制路径

binarypath_demo

黑洞

blackhole_demo

气泡

bubbles_demo

燃烧

burn_demo

解密

decrypt_demo

烟花

fireworks_demo

矩阵

matrix_demo

绕轨飞行

orbittingvolley_demo

倾倒

pour_demo

打印

print_demo

rain_demo

圆环

rings_demo

滑动

slide_demo

聚光灯

spotlights_demo

群集

swarm_demo

录像带

vhstape_demo

波浪

waves_demo

开发预览

以下显示的任何效果都在开发中,将在下一版本中提供。

最新发布说明

访问变更日志查看发布说明。

新功能(0.11.0)


新效果(0.11.0)

  • 矩阵效果。矩阵数字雨效果,以最后的幕布和字符解析阶段结束。

新引擎功能(0.11.0)

  • 画布现在可以任意调整大小。(-1 匹配输入文本尺寸,0 匹配终端尺寸)
  • 画布可以在终端周围锚定。
  • 文本可以在画布周围锚定。
  • 画布新属性 text_[left/right/top/bottom]text_width/height 以及 text_center_row/center_column
  • 版本开关(--version, -v)

变更(0.11.0)


效果变更(0.11.0)

  • 切片效果现在绝对计算文本中心,而不是通过平均行长度。
  • 打印效果不再将打印头移动到每行开始,只移回下一行的第一个字符。
  • 许多效果已更新以支持在画布内锚定。

引擎变更(0.11.0)

  • 改进了与圆相关的几何函数的性能。(10.0.1)
  • 渐变支持索引和切片。
  • EffectCharacter对象不再有symbol属性。相反,Animation类有一个新属性current_character_visual,提供对symbolcolor属性的访问,反映字符当前的符号和颜色。之前的EffectCharacter.symbol属性不可靠,根据访问时间表示格式化和未格式化的符号。此外,color属性现在是一个Color对象,颜色代码已移至_color_code属性。
  • EffectCharacter对象有一个新属性is_fill_character: bool

效果修复(0.11.0)

  • 修复了群集效果未处理第一个群集(右下角字符)导致输出中缺少字符的问题。(10.0.1)

其他(0.11.0)

  • 在效果动画期间,键盘中断得到了优雅处理。

许可证

根据MIT许可证分发。有关更多信息,请参阅LICENSE

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号