2
2
This program is a 2D screensaver which recreates the Pipes screensaver from old MS Windows versions.
3
3
4
4
## Features
5
- - Multiple sets of pieces (see the [ Piece Sets] ( #piece-sets ) section to see them)
6
- - Each pipe has its own color, the available palettes are: none (colorless), base colors and RGB.
7
- - Change the speed of drawing (FPS).
8
- - The minimal and maximal length of pipes can be specified
9
- - The maximal number of drawn characters can be also specified. To ignore this setting you can specify 0 via CLI.
10
- - The probability of turning pipes is changeable, it's given as a percentage in decimal form.
11
- Specifying 0 will make this program to draw straight pipes and 1 will make your screen look like...
12
- umm... pseudo dragon curve or something like that?
5
+ - 6 available piece sets (see the [ Piece Sets] ( #piece-sets ) section to see them).
6
+ - Each pipe has its own color; available palettes are: none (colorless), base colors (16 colors
7
+ defined by your terminal) and RGB.
8
+ - Changeable FPS (frames per second).
9
+ - The minimal and maximal length of pipes can be specified.
10
+ - The maximal number of drawn characters can be also specified. To ignore this setting specify 0
11
+ via CLI. The screen will be cleared when this number is reached.
12
+ - The probability of turning pipes is changeable, it's given as a percentage in decimal form (0 .. 1).
13
+ - It enters an alternate screen so it won't mess up your previous output (if your terminal does not
14
+ support alternate screen, see [ Installation] ( #installation ) ).
13
15
14
16
## Screenshots
15
17
@@ -22,7 +24,9 @@ umm... pseudo dragon curve or something like that?
22
24
You'll need the Rust toolchain ([ rustup] ( https://rustup.rs/ ) or from system package repo) and make
23
25
sure it's up to date.
24
26
25
- When the toolchain will be prepared, type ` cargo install rxpipes ` .
27
+ When the toolchain will be prepared, type ` cargo install rxpipes ` . If you want to disable the
28
+ alternate screen feature, add ` --no-default-features ` (currently, cargo does not support disabling
29
+ of individual features).
26
30
27
31
If you have installed successfully rxpipes, you can now run the it simply by typing ` rxpipes ` . If
28
32
the shell says that the command does not exists, make sure that ` $HOME/.cargo/bin ` (or whatever the
@@ -31,10 +35,11 @@ default cargo dir will be) is in the `PATH` environment variable.
31
35
To see all available options, pass ` -h ` or ` --help ` .
32
36
33
37
## Controls
34
- | Key | Action |
35
- | ----------------------| --------|
36
- | ` q ` / ` Q ` / ` Escape ` | Quit |
37
- | ` Space ` | Pause |
38
+ | Key | Action |
39
+ | ----------------------| --------------|
40
+ | ` q ` / ` Q ` / ` Escape ` | Quit |
41
+ | ` Space ` | Pause |
42
+ | ` c ` | Clear screen |
38
43
39
44
## Piece Sets
40
45
@@ -48,7 +53,7 @@ You can select a set by passing `-P <ID>` to rxpipes.
48
53
| 3 | Thin pipes | ![ ] ( screenshots/screenshot_p3.png ) |
49
54
| 4 | Thin pipes with rounded corners | ![ ] ( screenshots/screenshot_p4.png ) |
50
55
| 5 | Double pipes | ![ ] ( screenshots/screenshot_p5.png ) |
51
- | 6 | Bold pipes | ![ ] ( screenshots/screenshot_p6.png ) |
56
+ | 6 | Bold pipes (default) | ![ ] ( screenshots/screenshot_p6.png ) |
52
57
53
58
* The look of the selected set may differ from the screenshots as it depends on the font that you use.*
54
59
0 commit comments