Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pipeseroni/pipesX.sh

Animated pipes terminal screensaver at an angle.
https://github.com/pipeseroni/pipesX.sh

bash pipes-sh pipeseroni terminal-screensaver

Last synced: about 2 months ago
JSON representation

Animated pipes terminal screensaver at an angle.

Host: GitHub
URL: https://github.com/pipeseroni/pipesX.sh
Owner: pipeseroni
License: mit
Created: 2014-02-21T02:57:18.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2015-08-23T18:18:50.000Z (about 9 years ago)
Last Synced: 2024-06-15T22:36:16.739Z (3 months ago)
Topics: bash, pipes-sh, pipeseroni, terminal-screensaver
Language: Shell
Homepage: https://pipeseroni.github.io/
Size: 298 KB
Stars: 66
Watchers: 4
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

README

        =========

pipesX.sh

=========

  *Animated pipes terminal screensaver at an angle.*

.. note on taking the screenshots

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x210. A sample command, where terminal at +0+18,

  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x210+$((2+2))+$((20+2)) -file doc/pipesX.png

.. figure:: doc/pipesX.png

  :target: screencast_

  Screenshot of pipesX.sh, click to watch a screencast_ on YouTube.

.. _screencast: http://youtu.be/dITTlFPYVPA

.. contents:: **Contents**

   :local:

   :backlinks: top

How this started

================

In 2013, I modified the pipes.sh_ and it inspired me to create this version,

that is piping at an angle.

.. _pipes.sh: https://github.com/pipeseroni/pipes.sh

Requirements

============

* Bash 4+ since version 1.0.0.

Installation

============

If you want to install, you can run:

.. code:: sh

  $ make install

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

.. code:: sh

  $ make PREFIX=$HOME/.local install

Or any ``PREFIX`` you prefer.

The ``Makefile`` also provides ``uninstall`` target.

Options

=======

``-n [1-]``

-----------

Number of pipes (Default: 1).

``-t [#]``

----------

Types of pipes, can be used more than once (Default: 0).

.. note on taking the screenshots

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 480x140. A sample command, where terminal at +0+18,

  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 480x140+$((2+2))+$((20+2)) -file doc/pipesX.t#.png

+----------+-------------------------------+

| ``-t #`` | Charaters                     |

+==========+===============================+

| ``-t 0`` | ``╱╲``                        |

|          |                               |

|          | .. figure:: doc/pipesX.t0.png |

+----------+-------------------------------+

| ``-t 1`` | ``/\``                        |

|          |                               |

|          | .. figure:: doc/pipesX.t1.png |

+----------+-------------------------------+

| ``-t 2`` | ``..``                        |

|          |                               |

|          | .. figure:: doc/pipesX.t2.png |

+----------+-------------------------------+

| ``-t 3`` | ``oo``                        |

|          |                               |

|          | .. figure:: doc/pipesX.t3.png |

+----------+-------------------------------+

| ``-t 4`` | ``\/``                        |

|          |                               |

|          | .. figure:: doc/pipesX.t4.png |

+----------+-------------------------------+

``-t c[2 chars]``

-----------------

Custom pipe, for example: ``-t cR2 -t cD2``.

.. note on taking the screenshot

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x140. A sample command, where terminal at +0+18,

  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x140+$((2+2))+$((20+2)) -file doc/pipesX.tc.png

.. figure:: doc/pipesX.tc.png

``-i [float]``

--------------

Piping interval or maze generation interval. (Default: 0.05)

``-f [20-100]``

---------------

Framerate (Default: 75)

``-P [0-100]``

--------------

Probability of a turning pipe or of \ in maze generation. (Default: 25)

``-r LIMIT``

------------

Reset after x characters, 0 if no limit (Default: depending on screen size)

``-R``

------

Random starting point.

``-C``

------

No color.

.. note on taking the screenshot

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x140. A sample command, where terminal at +0+18,

  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x140+$((2+2))+$((20+2)) -file doc/pipesX.C.png

.. figure:: doc/pipesX.C.png

``-X``

------

Maze generation.

.. note on taking the screenshot

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x140. A sample command, where terminal at +0+18,

  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x140+$((2+2))+$((20+2)) -file doc/pipesX.X.png

.. figure:: doc/pipesX.X.png

``-h``

------

Help message.

``-v``

------

Print version number.

Controls

========

Press any key to exit, except in Bash < 4, :kbd:`Ctrl+C` to exit.

Copyright

=========

pipesX.sh is licensed under the MIT License, see LICENSE_.

.. _LICENSE: LICENSE