Metadata-Version: 2.4
Name: rmatrix
Version: 0.1.3
Summary: A fun and creative Matrix digital rain animation for your terminal.
Author-email: Nihal Sheikh <nihalsheikh585@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/nihalsheikh/rmatrix
Project-URL: Bug Tracker, https://github.com/nihalsheikh/rmatrix/issues
Project-URL: Official Website, https://rmatrix.vercel.app
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: windows-curses; platform_system == "Windows"

# Rmatrix - Personal Digital Rain Animation

[![PyPI version](https://img.shields.io/pypi/v/rmatrix.svg)](https://pypi.org/project/rmatrix/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Rmatrix Banner](https://raw.githubusercontent.com/nihalsheikh/rmatrix/main/assets/banner.png)

Rmatrix is a fun and creative digital rain animation for your terminal, inspired by the iconic visuals of The Matrix. It features 3D parallax depth, hand-calibrated 256-color palettes, and a customizable bookmark overlay. Built for the casual aesthetic, it's dependency-free and runs on anything with Python 3.6+.

## 🎬 Live Demo

Check out the interactive high-fidelity website at [rmatrix.vercel.app](https://rmatrix.vercel.app).

## ✨ Features

- **Pure Python:** No heavy dependencies, no bloat.
- **Cinematic Visuals:** High-fidelity animation optimized for the terminal.
- **Extreme Customization:** Over 20+ flags to tune speed, density, colors, and mutation rates.
- **Color Palettes:** 10+ hand-crafted color schemes (Classic Green, Blood Red, Ocean Blue, Sunset, etc.).
- **Zero Data:** Respects your privacy. No tracking, no telemetry.

## 🚀 Installation

To install Rmatrix officially from PyPI:

```bash
pip install rmatrix
```

Or run it directly without installing:

```bash
python3 -m rmatrix.main
```

## 🎮 Usage

Simply run:

```bash
rmatrix
```

Or use the shorter alias:

```bash
rmx
```

### Pro Examples:

**High-speed Gold rain with long trails:**
```bash
rmatrix -c gold -ch digits -l long -df
```

**Cyan rain with a custom "NEO" bookmark:**
```bash
rmatrix -b "NEO" -c cyan
```

## 🛠 Requirements

- Python 3.6+
- A terminal with `curses` support (standard on Linux/macOS)
- Windows: Use Windows Terminal or PowerShell for the best experience.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
Built with ❤️ for the community by Nihal Sheikh.
