README.md

Rust Mini matrix

🦀 rust implementation of mini-matrix - much faster

👨‍💻 Output random 0 and 1 or custom characters with a matrix-like effect

Installation 📦

Arch Linux 🐧

rmini-matrix is in the AUR

yay -S rmini-matrix

Other 🪟🐧

With make - Linux 🐧

Run make

# 📂 rmini-matrix/
make

Build from source - Linux 🐧 & Windows 🪟

clone github repo

git clone https://github.com/SkwalExe/rmini-matrix

build with cargo

# 📂 rmini-matrix/
cargo build --release

[ LINUX ONLY ] : Move the binary

# 📂 rmini-matrix/
sudo cp target/release/rmini-matrix /usr/bin/rmini-matrix

On windows the executable will be target\release\rmini-matrix.exe you can move it wherever you want.

Usage

Example

rmini-matrix -c 20 --custom-chars "abcdefghijklmnopqrstuvwxyz"

Example with polybar

[module/matrix]
type = custom/script
exec = rmini-matrix -c 20 -s 0.07
tail = true

Uninstall 🗑

With make

Run make uninstall

# 📂 rmini-matrix/
make uninstall

Or

Just remove the binary

sudo rm /usr/bin/rmini-matrix

Docker 🐳

Run the latest version

docker run --rm -it ghcr.io/skwalexe/rmini-matrix:main

Test your changes 🚧

Build 🛠️

# 📂 rmini-matrix/
docker build -t rmini-matrix .

Run 🏃

docker run --rm -it rmini-matrix [OPTIONS]

final

If you have any probleme, don't hesitate to open an issue

contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.