Metadata-Version: 2.4
Name: AsciiRenderer
Version: 0.0.1
Summary: A package for all things ASCII rendering.
Author: Jaiden Khosla
License-Expression: MIT
Project-URL: Homepage, https://github.com/JaidenKhosla/AsciiRenderer
Project-URL: Issues, https://github.com/JaidenKhosla/AsciiRenderer/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# AsciiRenderer

This is a simple AsciiRenderer package for Python.

As of right now, it's primarily for images/videos through OpenCV (Matlike objects)

## Basic Example:
```
import cv2 #OpenCV
from AsciiRenderer import AsciiRenderer

renderer = AsciiRenderer()

video_capture = cv2.VideoCapture(0)

while video_capture.isOpened():
    is_ok, frame = video_capture.read()

    if not is_ok:
        break

    ascii_frame = renderer.render(frame)

    cv2.imshow("AsciiRenderer", ascii_frame)

    if cv2.waitKey(1) & 0xFF == ord("q"):
        break

video_capture.release()
cv2.destroyAllWindows()
```

## Parameters for AsciiRenderer Object:

- SHADE_MAP (str): The shade map of the ascii renderer. Goes from darkest to lightest. Default is "1237456980".
- CELL_WIDTH (int): How wide you want an individual cell to take up. Default is 10px.
- CELL_HEIGHT (int): How tall you want an individual cell to take up. Default is 10px
- FONT (int): Enum Code for an OpenCV Font. Please use the following:
    - cv2.FONT_HERSHEY_SIMPLEX,
    - cv2.FONT_HERSHEY_PLAIN,
    - cv2.FONT_HERSHEY_DUPLEX,
    - cv2.FONT_HERSHEY_COMPLEX,
    - cv2.FONT_HERSHEY_TRIPLEX,
    - cv2.FONT_HERSHEY_COMPLEX_SMALL,
    - cv2.FONT_HERSHEY_SCRIPT_SIMPLEX,
    - cv2.FONT_HERSHEY_SCRIPT_COMPLEX

## Roadmap:

- __Add support for Ascii Rendering into a string.__
- Make the package useful outside of OpenCV
- Allow custom fonts.
