r-matrix 2.0.6

Rust port of cmatrix.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# rmatrix

[![CI](https://github.com/Fierthraix/rmatrix/actions/workflows/ci.yml/badge.svg)](https://github.com/Fierthraix/rmatrix/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/Fierthraix/rmatrix?display_name=tag)](https://github.com/Fierthraix/rmatrix/releases)
[![Crates.io](https://img.shields.io/crates/v/r-matrix.svg)](https://crates.io/crates/r-matrix)
[![Downloads](https://img.shields.io/crates/d/r-matrix.svg)](https://crates.io/crates/r-matrix)
[![Docs.rs](https://docs.rs/r-matrix/badge.svg)](https://docs.rs/r-matrix)
[![License](https://img.shields.io/crates/l/r-matrix.svg)](LICENSE)
[![AUR](https://img.shields.io/aur/version/rmatrix)](https://aur.archlinux.org/packages/rmatrix)
[![AUR bin](https://img.shields.io/aur/version/rmatrix-bin)](https://aur.archlinux.org/packages/rmatrix-bin)

Generates a 'Matrix'-like screen of falling characters in your terminal
[![rmatrix](rmatrix.gif)](https://asciinema.org/a/IjJyH88BeocsHvJpKJYqvmnuT)

The original [`cmatrix`](https://github.com/abishekvashok/cmatrix) was written in C, and crashes when you wildly resize the window.
The rust version is memory-safe, and doesn't crash so easily.
This version uses `crossterm` for cross-platform terminal support without needing `ncurses` installed.

## Controls
| Key | Control |
| -- | -- |
| 1-9 | Speed the letters fall (1 is fastest, 9 is slowest) |
| Shift + 1-9 | Colour of the characters |
| r | Rainbow mode |

## Installation

### Cargo

```bash
cargo install r-matrix
```

### Arch Linux / AUR

```bash
yay -S rmatrix
yay -S rmatrix-bin
```

### macOS / Homebrew

```zsh
brew install --cask Fierthraix/tap/rmatrix
```

### Windows / Scoop

```powershell
scoop bucket add fierthraix https://github.com/Fierthraix/scoop-bucket
scoop install rmatrix
```

### Nix

```bash
nix profile install github:Fierthraix/nur-packages#rmatrix
```

### Release Assets

```text
https://github.com/Fierthraix/rmatrix/releases/latest
```

## Development

Install the local pre-commit hooks with:

`pre-commit install`

The hooks run `cargo fmt --check`, `cargo clippy --all-targets --all-features -- -D warnings`, and `cargo test --all-targets --all-features`.
GitHub CI runs the same checks on Linux, macOS, and Windows.