Metadata-Version: 2.1
Name: ascvid
Version: 1.0.0
Summary: ASCII Video player.
Home-page: https://github.com/jenca-adam/ascvid
Author: Adam Jenca
Author-email: jenca.a@gjh.sk
Keywords: Video,ASCII,Terminal
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Multimedia :: Video :: Display
License-File: LICENSE


.. image:: https://raw.githubusercontent.com/jenca-adam/ascvid/main/asc.png

``ascvid`` is an ASCII video player with quite exact results. It is mostly advised to be used under Linux, but it might work on other OS too.
Here is a little showcase of what it can do: 

.. image:: https://raw.githubusercontent.com/jenca-adam/ascvid/main/rick.gif

It requires a Truecolor terminal to work like this. If you are on a stupider terminal, the results will look less realistic.The produced graphics aren't blinking as in other ASCII video players, however, the videos might lag a bit if your terminal is zoomed out.
``ascvid`` also supports audio! It's a true video player.

Installation
============

.. code-block:: console
   
   python3 -m pip install ascvid

Then you can just run ``ascvid`` and you're good to go.

CLI Options
===========
*NOTE :: --no-truecolor option lags like my brain, so if you are on a stupid terminal, you are better off using --no-color in ASCII mode.*
.. code-block:: console
    
    Usage: python -m ascvid [OPTIONS] FILE

    Options:
      -H, --hide-cursor   Hide the cursor while playing the video
      -A, --no-audio      Don't play audio stream
      -f, --fps TEXT      Number of FPS the video's supposed to run at. If None,
                          it's determined from the video. If "max", ascvid will
                          try its best to keep the video from lagging
      -c, --char TEXT     Character to be used while rendering the video frames
      -C, --no-color      Don't color output
      -a, --ascii         Use multiple ASCII characters. Best to be used with
                          --no-truecolor
      -T, --no-truecolor  Reduces color palette. Use this flag on more stupid
                          terminals (windows).
      -F, --fast          Toggles off resizing each frame individually, rather
                          resizes the entire video. Use this if the video is
                          lagging too much.
      --help              Show this message and exit.
    
