Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p-e-w/ternimal
Simulate a lifeform in the terminal
https://github.com/p-e-w/ternimal
art linux macos rust terminal
Last synced: 5 days ago
JSON representation
Simulate a lifeform in the terminal
- Host: GitHub
- URL: https://github.com/p-e-w/ternimal
- Owner: p-e-w
- License: gpl-3.0
- Created: 2017-10-15T10:44:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-19T08:05:21.000Z (almost 6 years ago)
- Last Synced: 2024-10-22T05:45:49.255Z (13 days ago)
- Topics: art, linux, macos, rust, terminal
- Language: Rust
- Size: 39.1 KB
- Stars: 1,063
- Watchers: 20
- Forks: 31
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- starred-awesome - ternimal - Simulate a lifeform in the terminal (Rust)
- awesome-starred - p-e-w/ternimal - Simulate a lifeform in the terminal (macos)
README
Ternimal
Simulate a lifeform in the terminal
Ter**n**i**m**al (note the spelling) is a program that draws an animated lifeform in the terminal using [Unicode block symbols](https://en.wikipedia.org/wiki/Block_Elements). It works in [most terminal emulators](#faq) and with most monospaced fonts.
From a practical perspective, the program is not very useful. It does, however, contain quite a bit of cool technology and math:
* "Glow" renderer capable of 1000+ frames per second (if the terminal can handle it)
* Dynamic generation of an everywhere differentiable movement path composed of circular arcs
* Skeletal deformation along the path
* [Fourier](https://en.wikipedia.org/wiki/Fourier_series)-based shape description allowing for many body forms to be realized and animated
Ternimal is also an exercise in minimalism and restraint. Written in just 1000 lines of Rust, it has *no dependencies* and consumes very few resources: 400 kB on disk, 3 MB of RAM and 4 % of a single CPU core with the default parameters. It implements its own linear algebra operations from scratch, as well as basic command line parsing and a simple random number generator.
## Building
Ternimal has no dependencies apart from the Rust Standard Library, and does not require Cargo for building. Only `rustc` (>= 1.20) must be installed, at which point Ternimal can be built with:
```
git clone https://github.com/p-e-w/ternimal.git
cd ternimal
rustc -O ternimal.rs
```
## Usage
Fundamentally, Ternimal does nothing more than color the distance field from a segment of a meandering path. There are [many parameters](ternimal.rs#L88-L173) controlling this process, however, nearly all of which can be manipulated through the command line.
This makes the system very flexible. The following are just a few examples of what is possible:
### "Anaconda"
```
./ternimal length=100 thickness=1,4,1,0,0 radius=6,12 gradient=0:#666600,0.5:#00ff00,1:#003300
```
Sine waves can be used to generate quite organic-looking shapes. In this case, a single half-wave forms the body of a snake.
### "Swarm"
```
./ternimal length=200 thickness=0,4,19,0,0
```
Ternimal only renders a single model. However, thickness variations can give the appearance of multiple disconnected entities moving in a coordinated fashion.
### "Rainbow"
```
./ternimal length=20 thickness=70,15,0,1,0 padding=10 radius=5 gradient=0.03:#ffff00,0.15:#0000ff,0.3:#ff0000,0.5:#00ff00
```
The thickness function includes a time parameter. This makes it possible to define shape animations. Arbitrarily many Fourier series terms can be specified, enabling very complex animations.
## Performance
Ternimal is highly optimized for performance, to the extent that in many situations, the CPU time needed to generate its output is less than that taken by the terminal emulator to display the same. Various tricks are employed to minimize computational load and output size. In GNOME Terminal, the default parameters render up to 2500 frames per second.
I have tried everything under the sun to squeeze out even more performance, with mixed results. Some of the unsuccessful/semi-successful attempts include:
* Using `f32` in place of `f64`. This does give a speedup of 5-10 %, but [runs into precision problems](https://blog.demofox.org/2017/11/21/floating-point-precision/) after a few days. It might be possible to "reset" the time and position values in regular intervals to avoid this, but the logic would be quite complex.
* Pre-computing samples of the thickness function, and substituting those for the full evaluation. With some models, this idea can improve performance by up to 5 %, but it works only for time-independent thickness functions and adds a lot of ugly code.
* Manually handling `stdout` locking and/or buffering. Although Ternimal writes a large amount of output, this optimization results only in a disappointing 1 % speedup and was therefore abandoned.
* Reducing memory allocations, e.g. by using a (sufficiently large) fixed-capacity string when building output. This had no measurable impact at all.
* "Optimizing" string construction. It turns out that Rust's `format!` macro is hard to beat for this purpose, and every alternative I tried was either equal or slower.
* Playing around with compiler flags like `target-cpu=native`. This also gave no measurable improvement.
[Profiling with Callgrind and OProfile](https://llogiq.github.io/2015/07/15/profiling.html) reveals that most of the CPU time is spent constructing and writing the output string and that rendering computations only play a role for very large models. Given the lack of success trying to make output handling faster, it seems reasonable to say Ternimal's performance is already quite satisfactory.
## FAQ
### What platforms and terminals are supported?
Ternimal has been tested on Linux, macOS, and Windows.
On Linux, almost all terminal emulators render Ternimal flawlessly. On macOS, iTerm2 or Alacritty are recommended. On Windows, PowerShell and WSL appear to work well, with ConEmu also working but lacking 24-bit colors.
### Why am I seeing random/weird colors?
Most likely because your terminal does not support 24-bit RGB color escape sequences. This in turn probably means that you are using macOS' default Terminal.app, which is the only major terminal emulator still missing that feature.
You have two options:
* Switch to a terminal that supports true color escape sequences. A well-researched list of such terminals can be found [here](https://gist.github.com/XVilka/8346728).
* Run Ternimal with the argument `true_color=false` to fall back to a 256-color palette, which is supported by practically every terminal emulator (but doesn't look as nice).
### Why am I seeing grid lines?
Either because your font's block characters do not completely fill the character cell, or because your terminal has line spacing greater than zero.
Ternimal works best with fonts that have a character aspect ratio as close to 2:1 as possible. The font in the screencasts is the wonderful [Iosevka](https://github.com/be5invis/Iosevka).
### Why does it look strange in the Linux (kernel) console?
The Linux console does not support Unicode fonts. It does, however, appear to recognize the Unicode *encoding*, and attempts to translate certain Unicode code points to code points in its internal encoding, which includes the block symbols required by Ternimal.
There appears to be a bug in this conversion, though. The *UPPER HALF BLOCK* character is translated correctly, but the *LOWER HALF BLOCK* is not, resulting in a striped pattern.
### How does it look in [cool-retro-term](https://github.com/Swordfish90/cool-retro-term)?
Like this:
## Contributing
Contributors are always welcome. However, **please file an issue describing what you intend to add before opening a pull request,** *especially* for new features! I have a clear vision of what I want (and do not want) Ternimal to be, so discussing potential additions might help you avoid duplication and wasted work.
By contributing, you agree to release your changes under the same license as the rest of the project (see below).
## License
Copyright © 2017 Philipp Emanuel Weidmann ()
Released under the terms of the [GNU General Public License, version 3](https://gnu.org/licenses/gpl.html)