matrixr 1.1.0

Animated Matrix-style terminal screensaver
Documentation

Features

  • Independent Matrix streams that adapt to terminal resizing
  • ASCII, Japanese half-width kana, lambda, and legacy X-window character modes
  • Normal and old-style scrolling, asynchronous streams, and live character mutation
  • Named colors, rainbow mode, and random or all-character bold rendering
  • Deep Mode with a distance-based RGB tail fade and smooth near/middle/far parallax
  • Separate controls for simulation speed and render FPS
  • Pause, lock, and screensaver behavior with transient status overlays
  • Alternate-screen rendering, optional TTY output, and terminal state restoration
  • Optional Linux console font support through setfont matrix

Installation

From crates.io

After the package is published:

cargo install matrixr

With Nix (Flake)

nix run github:WhoSowSee/matrixr
nix profile install github:WhoSowSee/matrixr

Use nix run to try matrixr without installing it, or nix profile install to add it permanently to your Nix profile.

From source

git clone https://github.com/WhoSowSee/matrixr.git
cd matrixr
cargo install --path .

Both methods install a single executable named matrixr.

Quick start

matrixr
matrixr -D
matrixr -ba -u 2 -C red
matrixr -r -k
matrixr -L

General syntax:

matrixr -[DabBcfhlsmVxk] [-u speed] [-C color] [-t tty]

CLI options

Option Description
-D Start in Deep Mode with an RGB depth fade and smooth parallax
-a Use asynchronous stream updates
-b Enable random bold characters
-B Make all characters bold; overrides -b
-n Disable bold characters; overrides -b and -B
-c Use the Japanese half-width kana character set
-m Enable lambda mode
-k Mutate characters while streams move
-o Use old-style scrolling
-r Enable rainbow colors
-C color Set green, red, blue, white, yellow, cyan, magenta, or black
-u 0..10 Set the initial simulation delay in 10 ms units; default 4, 0 is unlimited
-L Start locked; lock and unlock messages remain visible for 3 seconds
-s Screensaver mode; exit on the first key press
-x Enable legacy X-window character behavior
-l Linux console mode; attempt to load the matrix console font
-f Force TERM=linux before terminal initialization
-t tty Render to a specific TTY device
-h Print help
-V Print version information

Runtime controls

Key Action
~ Toggle the centered keyboard shortcuts popup
q Quit when not locked
Ctrl+C Quit when not locked
D Toggle Deep Mode without clearing existing streams
a Toggle asynchronous updates
b / B / n Random bold / all bold / bold off
c Toggle the Japanese character set when not locked
m Toggle lambda mode
k Toggle live character mutation
o Toggle old-style scrolling
r Toggle rainbow mode
x Toggle legacy X-window behavior
p or P Pause or resume the simulation
L Lock or unlock the application
0..9 Set simulation speed; 0 is unlimited
d / f Decrease / increase render FPS from 1 to 120; hold to adjust continuously

Setting changes are displayed in a top-right overlay for one second.

Color hotkeys

Key Color
! Red
@ Green
# Yellow
$ Blue
% Magenta
^ Cyan
& White
) Black

Selecting a color disables rainbow mode.

Development

cargo fmt -- --check
cargo test
cargo clippy --all-targets --all-features -- -D warnings
cargo build --release