cmdtrix

matrix-console-effect made in Python.
Explore the code »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Made With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Examples
   • Help
4. License
5. Contact

About The Project

This project simply emulates "The Matrix"-effect on any console-terminal.

Made With

(back to top)

Getting Started

Prerequisites

It is necessary that a font is installed that supports the unicode characters used (greek, cyrillic).

Installation

1. install the python package (PyPI-cmdtrix):

pip install cmdtrix

pip install git+https://github.com/SilenZcience/cmdtrix.git

(back to top)

Usage

cmdtrix [-h] [-c COLOR] ...

python -m cmdtrix [-h] [-c COLOR] ...

Argument	Description
-h, --help	show help message and exit
-v, --version	output version information
-c [*], --color [*]	set the main-color to *
-p [*], --peak [*]	set the peak-color to *
-r, --rainbow	enable rainbow color transitions
-d p, --dim p	add chance p (percent) for dim characters
-i p, --italic p	add chance p (percent) for italic characters
-b, --bottomup p	add chance p (percent) for bottom-up cascades
-m * p c	hide a custom message * within the Matrix, with chance p and color c
-S *, --symbols *	set a custom series of symbols to choose from
-j, --japanese	use japanese characters (overrides -S; requires appropriate fonts)
-s, --synchronous	sync the matrix columns speed
--framedelay DELAY	set the framedelay (in sec) to slow down the Matrix, default is 0.015
--timer DELAY	exit the Matrix after DELAY (in sec) automatically
--onkey	only spawn columns on key-press

Examples

cmdtrix -m SilenZcience 5 red -m cmdtrix 5 blue -d 5 -m Star*The*Repo 10 magenta

Help

Q: Why am i seeing weird characters like �[31;1mr�[0m in the console?

A: This project uses ANSI-Escape Codes to display colors in the Terminal. If you see these weird characters, then your Terminal does not support these Codes.

⚠️If you are using the Conhost Command Prompt on Windows you can most likely solve this issue by going in the Registry under Computer\HKEY_CURRENT_USER\Console and adding/editing the DWORD value VirtualTerminalLevel and setting it to 1.

---

Q: Why are some characters partially white even though i specified a color?

A: This is a Bug inside the Terminal you are using. You can fix the issue by disabling all dimmed and italic characters using -d 0 -i 0

(back to top)

License

This project is licensed under the MIT License - see the LICENSE file for details

Contact

SilenZcience