pipes.sh

Animated pipes terminal screensaver.

Screenshot of pipes.sh, click to watch a screencast on YouTube.

Contents

• Requirements
• Installation
• Options
  • Full List
  • -t [#]: pipe types
  • -t c[16 chars]: custom pipe
  • -c [0-7]: colors
  • -C: no colors
• Controls
• Reporting an Issue
• Contribution
• Copyright

Requirements

• Bash 4+ since version 1.0.0.

Installation

If you want to install, you can run:

$ make install

By default, it installs to /usr/local; for user home, you can run:

$ make PREFIX=$HOME/.local install

Or any PREFIX you prefer.

The Makefile also provides uninstall target.

If you are a Homebrew user, you can install via:

$ brew install pipes-sh

Options

Full List

Options	Descrptions (Defaults)
-p [1-]	Number of pipes (1)
-t [#]	Type of pipes, can be used more than once (0)
-c [0-7]	Color of pipes, can be used more than once (1 2 3 4 5 6 7 0)
-f [20-100]	Framerate (75)
-s [5-15]	Probability of a straight fitting (13)
-r LIMIT`	Reset after x characters, 0 if no limit (2000)
-R	Random starting point
-B	No bold effect
-C	No color
-K	Pipes keep their color and type when hitting the screen edge
-h	Help message
-v	Print version number

-t [#]: pipe types

-t #	Characters	Screenshots
-t 0	┃┏ ┓┛━┓ ┗┃┛┗ ┏━
-t 1	│╭ ╮╯─╮ ╰│╯╰ ╭─
-t 2	│┌ ┐┘─┐ └│┘└ ┌─
-t 3	║╔ ╗╝═╗ ╚║╝╚ ╔═
-t 4	|+ ++-+ +|++ +-
-t 5	|/ \/-\ \|/\ /-
-t 6	.. .... .... ..
-t 7	.o oo.o o.oo o.
-t 8	-\ /\|/ /-\/ \| (railway)
-t 9	╿┍ ┑┚╼┒ ┕╽┙┖ ┎╾ (knobby)

-t c[16 chars]: custom pipe

For example, -t cMAYFORCEBWITHYOU.

-c [0-7]: colors

0	background	1	red	2	green	3	yellow
4	blue	5	magenta	6	cyan	7	foreground

-C: no colors

Controls

Press any key to exit the program, except the following Shift + Key:

Keys	Actions
P / O	Increase/decrease probability of straight pipes
F / D	Increase/decrease frame rate
B	Toggle bold effect
C	Toggle no colors
K	Toggle keeping pipe color and type when crossing edges

Reporting an Issue

• Reporting a bug

Contribution

Feel free to fork and/or create pull request following the guideline. If you're contributing, remember your changes will be released under the MIT license.

Copyright

pipes.sh is licensed under the MIT License.