Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chris17453/ttygif
A modern text to gif tool. For use in headless ci/cd environments providing themed output for documentation.
https://github.com/chris17453/ttygif
asciicast automation cicd gif terminal-emulator themes ttygif
Last synced: 5 days ago
JSON representation
A modern text to gif tool. For use in headless ci/cd environments providing themed output for documentation.
- Host: GitHub
- URL: https://github.com/chris17453/ttygif
- Owner: chris17453
- Created: 2019-03-25T19:06:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-03T22:15:32.000Z (over 2 years ago)
- Last Synced: 2024-10-31T19:42:51.970Z (11 days ago)
- Topics: asciicast, automation, cicd, gif, terminal-emulator, themes, ttygif
- Language: Python
- Homepage:
- Size: 9.15 MB
- Stars: 27
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# ttygif
A full featured text to gif conversion utility, that just works. It's in beta, so expect rough edges.
It's a DIY terminal emulator that reads from STDIN or asciicast file to render themed gif's with layers. Great for documentation and power point presentations.
## ttygif in action
## Whats the hell is this?
- It's sparkling fantastic colorfull terminal output AUTOMATION!
## how do i get it!?
```bash
## requirements gcc, python development libs, cython
yum install python-devel gcc
pip3 install ttygif --user
```
## What are the benifits
- pipe output into beautifuly themed gifs
- asciicast to gif
- perfect fit for CI/CD
- it runs headless
- it can be scripted
- works with python 2 and 3
- works on linux, mac, raspberry PI
- its fast, and easy to install
- it has themes
- you can make custom themes!
- you can add background images from the CLI
## It's portable
ttygif is self contained with no dependencys other than python/cython. GIF encoding
and termal emulation are both implimented with internal cython code. No system
fonts are required. All you need to get ttygif to work is a c compiler,
python and its development libs. ttygif is a cython project.
### shipped themes
- default (256 color xterm palette)
- default-4bit (16 colorxterm palette)
- default-2bit (monochrome palette)
- windows7 (windows style wrapped terminal)
- game (8 bit inspired frame)
- mac (mac styled window)
- fwdm (old linux style window)
- scripted (bottom bar with text)
- opensouirce (bottom bar with text)
- bar (bottom bar with NO text)
## Supported fonts
- All fonts came from [https://int10h.org/oldschool-pc-fonts](https://int10h.org/oldschool-pc-fonts/)
- copyright FON conversion © 2015 VileR, license: CC BY-SA 4.0
- ttygif supports the "fd" font format. Basicly text files.
- All .FON files have been exported to fd files for portability.
- All fonts are copyright of their perspective owners, not me.
- default font=Verite_9x16
Check them all out here -> [fonts.md](/docs/fonts.md)
## ttygif-assets
The following resources are located in the [ttygif-assets](https://github.com/chris17453/ttygif-assets) repo
### Examples
some random pics from the asciinema.org website, and my computer
## pipe
## [Terminal ray tracing](https://asciinema.org/a/174524)
## [term-tris dt cannon](https://asciinema.org/a/232377)
- with game theme
## [Denariusd compile on 30 cores!](https://asciinema.org/a/234628)
## [surpirsed Pikachu](https://asciinema.org/a/236096)
## [CACA_DRIVER=ncurses cacademo](https://asciinema.org/a/687)
