| Name | cmdtrix JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | |
| Summary | Matrix-console-effect made in Python. |
| upload_time | 2023-08-10 12:20:41 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
console
crossplatform
matrix
python
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div id="top"></div>
<p>
<a href="https://pepy.tech/project/cmdtrix/" alt="Downloads">
<img src="https://static.pepy.tech/personalized-badge/cmdtrix?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads" align="right">
</a>
<a href="https://pypi.org/project/cmdtrix/" alt="Visitors">
<img src="https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.cmdtrix&right_color=orange" align="right">
</a>
<a href="https://github.com/SilenZcience/cmdtrix/tree/main/cmdtrix/" alt="CodeSize">
<img src="https://img.shields.io/github/languages/code-size/SilenZcience/cmdtrix?color=purple" align="right">
</a>
</p>
[![OS-Windows]][OS-Windows]
[![OS-Linux]][OS-Linux]
[![OS-MacOS]][OS-MacOS]
<br/>
<div align="center">
<h2 align="center">cmdtrix</h2>
<p align="center">
matrix-console-effect made in Python.
<br/>
<a href="https://github.com/SilenZcience/cmdtrix/blob/main/cmdtrix/main.py">
<strong>Explore the code »</strong>
</a>
<br/>
<br/>
<a href="https://github.com/SilenZcience/cmdtrix/issues">Report Bug</a>
·
<a href="https://github.com/SilenZcience/cmdtrix/issues">Request Feature</a>
</p>
</div>
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#made-with">Made With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a>
<ul>
<li><a href="#examples">Examples</a></li>
</ul>
</li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
</details>
## About The Project
This project simply emulates "The Matrix"-effect on any console-terminal.
### Made With
[![Python][MadeWith-Python]](https://www.python.org/)
[![Python][Python-Version]](https://www.python.org/)
<p align="right">(<a href="#top">back to top</a>)</p>
## Getting Started
### Prerequisites
It is necessary that a font is installed that supports the unicode characters used (greek, cyrillic).
### Installation
[![Version][CurrentVersion]](https://pypi.org/project/cmdtrix/)
1. install the python package ([PyPI-cmdtrix](https://pypi.org/project/cmdtrix/)):
```console
pip install cmdtrix
```
```console
pip install git+https://github.com/SilenZcience/cmdtrix.git
```
<p align="right">(<a href="#top">back to top</a>)</p>
## Usage
```console
cmdtrix [-h] [-c COLOR] ...
```
```console
python -m cmdtrix [-h] [-c COLOR] ...
```
| Argument | Description |
|------------------------|----------------------------------------------------------------------|
| -h, --help | show help message and exit |
| -v, --version | output version information |
| -s, --synchronous | sync the matrix columns speed |
| -c [\*], --color [\*] | set the main-color to * |
| -p [\*], --peak [\*] | set the peak-color to * |
| -d p, --dim p | add chance p (percent) for dim characters |
| -i p, --italic p | add chance p (percent) for italic characters |
| -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) |
| --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
```console
cmdtrix -m SilenZcience 5 red -m cmdtrix 5 blue -d 5 -m Star*The*Repo 10 magenta
```
> 
<!--  -->
<p align="right">(<a href="#top">back to top</a>)</p>
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/cmdtrix/blob/main/LICENSE) file for details
## Contact
> **SilenZcience** <br/>
[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)
[OS-Windows]: https://img.shields.io/badge/os-windows-green
[OS-Linux]: https://img.shields.io/badge/os-linux-green
[OS-MacOS]: https://img.shields.io/badge/os-macOS-green
[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen
[Python-Version]: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue
[CurrentVersion]: https://img.shields.io/pypi/v/cmdtrix.svg
[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange
Raw data
{
"_id": null,
"home_page": "",
"name": "cmdtrix",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "console,crossplatform,matrix,python,terminal",
"author": "",
"author_email": "\"Silas A. Kraume\" <silas.kraume1552@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/99/99/4f963ad406c0edcaa5dfacf14183cba6d1f2b517f3724907e167b573484d/cmdtrix-0.1.9.tar.gz",
"platform": null,
"description": "<div id=\"top\"></div>\n\n<p>\n <a href=\"https://pepy.tech/project/cmdtrix/\" alt=\"Downloads\">\n <img src=\"https://static.pepy.tech/personalized-badge/cmdtrix?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads\" align=\"right\">\n </a>\n <a href=\"https://pypi.org/project/cmdtrix/\" alt=\"Visitors\">\n <img src=\"https://visitor-badge.laobi.icu/badge?page_id=SilenZcience.cmdtrix&right_color=orange\" align=\"right\">\n </a>\n <a href=\"https://github.com/SilenZcience/cmdtrix/tree/main/cmdtrix/\" alt=\"CodeSize\">\n <img src=\"https://img.shields.io/github/languages/code-size/SilenZcience/cmdtrix?color=purple\" align=\"right\">\n </a>\n</p>\n\n[![OS-Windows]][OS-Windows]\n[![OS-Linux]][OS-Linux]\n[![OS-MacOS]][OS-MacOS]\n\n<br/>\n<div align=\"center\">\n<h2 align=\"center\">cmdtrix</h2>\n <p align=\"center\">\n matrix-console-effect made in Python.\n <br/>\n <a href=\"https://github.com/SilenZcience/cmdtrix/blob/main/cmdtrix/main.py\">\n <strong>Explore the code \u00bb</strong>\n </a>\n <br/>\n <br/>\n <a href=\"https://github.com/SilenZcience/cmdtrix/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/SilenZcience/cmdtrix/issues\">Request Feature</a>\n </p>\n</div>\n\n\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#made-with\">Made With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a>\n <ul>\n <li><a href=\"#examples\">Examples</a></li>\n </ul>\n </li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n </ol>\n</details>\n\n## About The Project\n\nThis project simply emulates \"The Matrix\"-effect on any console-terminal.\n\n### Made With\n[![Python][MadeWith-Python]](https://www.python.org/)\n[![Python][Python-Version]](https://www.python.org/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Getting Started\n\n### Prerequisites\n\nIt is necessary that a font is installed that supports the unicode characters used (greek, cyrillic).\n\n### Installation\n[![Version][CurrentVersion]](https://pypi.org/project/cmdtrix/)\n\n1. install the python package ([PyPI-cmdtrix](https://pypi.org/project/cmdtrix/)):\n```console\npip install cmdtrix\n```\n```console\npip install git+https://github.com/SilenZcience/cmdtrix.git\n```\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Usage\n\n```console\ncmdtrix [-h] [-c COLOR] ...\n```\n```console\npython -m cmdtrix [-h] [-c COLOR] ...\n```\n\n| Argument | Description |\n|------------------------|----------------------------------------------------------------------|\n| -h, --help | show help message and exit |\n| -v, --version | output version information |\n| -s, --synchronous | sync the matrix columns speed |\n| -c [\\*], --color [\\*] | set the main-color to * |\n| -p [\\*], --peak [\\*] | set the peak-color to * |\n| -d p, --dim p | add chance p (percent) for dim characters |\n| -i p, --italic p | add chance p (percent) for italic characters |\n| -m * p c | hide a custom message * within the Matrix, with chance p and color c |\n| -S \\*, --symbols \\* | set a custom series of symbols to choose from |\n| -j, --japanese | use japanese characters (overrides -S; requires appropriate fonts) |\n| --framedelay DELAY | set the framedelay (in sec) to slow down the Matrix, default is 0.015|\n| --timer DELAY | exit the Matrix after DELAY (in sec) automatically |\n| --onkey | only spawn columns on key-press |\n\n### Examples\n\n```console\ncmdtrix -m SilenZcience 5 red -m cmdtrix 5 blue -d 5 -m Star*The*Repo 10 magenta\n```\n> ![Example0](https://raw.githubusercontent.com/SilenZcience/cmdtrix/main/img/cmdtrix.gif \"example0\")\n\n<!-- ![Example1](https://raw.githubusercontent.com/SilenZcience/cmdtrix/main/img/example1.gif \"example1\") -->\n\n![Example2](https://raw.githubusercontent.com/SilenZcience/cmdtrix/main/img/example2.gif \"example2\")\n\n![Example2](https://raw.githubusercontent.com/SilenZcience/cmdtrix/main/img/example3.gif \"example3\")\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/cmdtrix/blob/main/LICENSE) file for details\n\n## Contact\n\n> **SilenZcience** <br/>\n[![GitHub-SilenZcience][GitHub-SilenZcience]](https://github.com/SilenZcience)\n\n[OS-Windows]: https://img.shields.io/badge/os-windows-green\n[OS-Linux]: https://img.shields.io/badge/os-linux-green\n[OS-MacOS]: https://img.shields.io/badge/os-macOS-green\n\n[MadeWith-Python]: https://img.shields.io/badge/Made%20with-Python-brightgreen\n[Python-Version]: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue\n\n[CurrentVersion]: https://img.shields.io/pypi/v/cmdtrix.svg\n\n[GitHub-SilenZcience]: https://img.shields.io/badge/GitHub-SilenZcience-orange\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Matrix-console-effect made in Python.",
"version": "0.1.9",
"project_urls": {
"Download": "https://github.com/SilenZcience/cmdtrix/tarball/master",
"Github": "https://github.com/SilenZcience/cmdtrix",
"Tracker": "https://github.com/SilenZcience/cmdtrix/issues"
},
"split_keywords": [
"console",
"crossplatform",
"matrix",
"python",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f98fbf16f56f25e8fe4083241d3ee83e2a0cb0e6da1a255f8f23d9928e12c32",
"md5": "f4f3786b0547fc2be7f71d95ad414552",
"sha256": "1a7e9dff5556bcc27ffa0fb92fa5fcfee4996991d18062467a6d2f14d614c840"
},
"downloads": -1,
"filename": "cmdtrix-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4f3786b0547fc2be7f71d95ad414552",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12469,
"upload_time": "2023-08-10T12:20:39",
"upload_time_iso_8601": "2023-08-10T12:20:39.506148Z",
"url": "https://files.pythonhosted.org/packages/5f/98/fbf16f56f25e8fe4083241d3ee83e2a0cb0e6da1a255f8f23d9928e12c32/cmdtrix-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99994f963ad406c0edcaa5dfacf14183cba6d1f2b517f3724907e167b573484d",
"md5": "af6c16448f8182b59a6f93193e5c3fcd",
"sha256": "cbfa606add0e994995aa37d5cdd23e39d881a4bab1ebb1b23a6351a720c35e99"
},
"downloads": -1,
"filename": "cmdtrix-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "af6c16448f8182b59a6f93193e5c3fcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11725,
"upload_time": "2023-08-10T12:20:41",
"upload_time_iso_8601": "2023-08-10T12:20:41.033560Z",
"url": "https://files.pythonhosted.org/packages/99/99/4f963ad406c0edcaa5dfacf14183cba6d1f2b517f3724907e167b573484d/cmdtrix-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-10 12:20:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SilenZcience",
"github_project": "cmdtrix",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cmdtrix"
}
