pipes-rs
An over-engineered rewrite of pipes.sh in Rust
Installlation
macOS
Install using Homebrew or download manually from releases.
$ brew install CookieCoder15/tap/pipes-rsLinux & Windows
See releases.
Configuration
pipes-rs can be configured using TOML located at ~/.config/pipes-rs/config.toml.
The following is an example file with the default settings:
bold = true
color_mode = "ansi" # ansi, rgb or none
palette = "default" # default, darker, pastel or matrix
delay_ms = 20
inherit_style = false
kinds = ["heavy"] # heavy, light, curved, knobby, emoji, outline, dots
num_pipes = 1
reset_threshold = 0.5 # 0.0–1.0
turn_chance = 0.15 # 0.0–1.0Color Modes
| Mode | Description |
|---|---|
ansi |
pipe colors are randomly selected from the terminal color profile, default option |
rgb |
pipe colors are randomly generated rgb values, unsupported in some terminals |
none |
pipe colors will not be set and use the current terminal text color |
Palettes
| Palette | Description |
|---|---|
default |
bright colors – good on dark backgrounds, default option |
darker |
darker colors – good on light backgrounds |
pastel |
pastel colors – good on dark backgrounds |
matrix |
colors based on Matrix digital rain – good on dark backgrounds |
Pipe Kinds
| Kind | Preview |
|---|---|
heavy |
┃ ┃ ━ ━ ┏ ┓ ┗ ┛ |
light |
│ │ ─ ─ ┌ ┐ └ ┘ |
curved |
│ │ ─ ─ ╭ ╮ ╰ ╯ |
knobby |
╽ ╿ ╼ ╾ ┎ ┒ ┖ ┚ |
emoji |
👆 👇 👈 👉 👌 👌 👌 👌 |
outline |
║ ║ ═ ═ ╔ ╗ ╚ ╝ |
dots |
• • • • • • • • |
Due to emojis having a different character width, using the emoji pipe kind along side another pipe kind can cause spacing issues.
Options
There are also command line options that can be used to override parts of the configuration file:
| Option | Usage | Example |
|---|---|---|
-b |
toggles bold text | -b true |
-c |
sets the color mode | -c rgb |
-d |
sets the delay in ms | -d 15 |
-i |
toggles if pipes inherit style when hitting the edge | -i false |
-k |
sets the kinds of pipes, each kind separated by commas | -k heavy,curved |
-p |
sets the number of pipes onscreen | -p 5 |
-r |
sets the percentage of the screen to be filled before resetting | -r 0.75 |
-t |
chance of a pipe turning each frame | -t 0.15 |
--palette |
sets the color palette, RGB mode only | --palette pastel |
Credits
Contributors
pipes-rs is maintained by CookieCoder15 and arzg; any other contributions via PRs are welcome! Forks and modifications are implicitly dual-licensed under Apache 2.0 OR MIT. Please credit the above contributers and pipes.sh when making modifications.
Inspiration
This project is based off of pipes.sh.