Metadata-Version: 2.1
Name: textfx
Version: 0.1.1
Summary: textfx is a Python library for creating dynamic and visually engaging text effects.
Home-page: https://github.com/iliakarimi/textfx
Author: Ilia Karimi
Author-email: 
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# Textfx

Textify is a Python library for creating dynamic and visually engaging text effects. It offers multiple functions to display text with unique animations and styles, perfect for enhancing console-based projects.

## Features

- **Typing Effect**: Simulates the effect of typing text character by character.

- **Falling Text**: Characters "fall" into place, similar to the rain effect from *The Matrix*.

- **Scramble Effect**: Displays random characters that gradually transform into the actual text.

- **Wave Text**: Makes the text move in a wave-like pattern.

## Installation

Currently, Textfx is not available on PyPI. You can clone this repository and use the `textfx.py` file directly in your project:

```bash
git clone https://github.com/iliakarimi/textfx.git
```

Then, import the required functions in your Python script:

```python
from textfx import typeeffect, falltext, scrameffect, wavetext
```

## Usage

Below are examples of how to use each function:

### Typing Effect

```python
from textfx import typeeffect

typeeffect("Hello, world!", delay=0.1)
```

### Falling Text

```python
from textfx import falltext

falltext("Falling Text", delay=0.2)
```

### Scramble Effect

```python
from textfx import scrameffect

scrameffect("Scrambled Text", delay=0.1)
```

### Wave Text

```python
from textfx import wavetext

wavetext("Wave Text", delay=0.2)
```

## Dependencies

- Python 3.x

## Contributing

Feel free to fork this repository and submit pull requests. Suggestions for new effects and improvements are always welcome!

## License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Enjoy using Textify! Let your text come to life!

