Skip to content

Commit ad206fb

Browse files
committed
📝 add README.rst
1 parent 5fb625b commit ad206fb

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

README.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
BadApple
2+
========
3+
4+
Python Module: Play the video in the console as ASCII art.
5+
6+
Where there is light, there is [Bad Apple!!][ba]
7+
8+
Install
9+
-------
10+
11+
.. code-block:: shell
12+
python -m pip install badapple
13+
14+
Run
15+
---
16+
17+
.. code-block:: shell
18+
python -m badapple
19+
20+
Help message
21+
------------
22+
23+
.. code-block:: md
24+
usage: badapple [options] ...
25+
26+
BadApple-Python-OS-ISA-v0.0.3
27+
28+
options:
29+
-h, --help show this help message and exit
30+
--help_audio show avaliable players
31+
-i INPUT, --input INPUT
32+
video file (use _BA_MP4 or _BA_BA to load built-in video)
33+
-o OUTPUT, --output OUTPUT
34+
preload output file
35+
--font FONT font data file
36+
--audio AUDIO audio file (use _BA_WAV, _BA_MP3 or _BA_MP4 to load built-in audio)
37+
--audio_player AUDIO_PLAYER
38+
audio player [auto ffplay avplay mpv vlc mpg123 cmus simpleaudio pyaudio playsound pydub]
39+
-s SCALE, --scale SCALE
40+
width:height
41+
-r RATE, --rate RATE frame rate
42+
--not_clear not clear screen (with ANSI) before each frame
43+
--contrast contrast enhancement
44+
--preload preload video (not play)
45+
--debug debug
46+
47+
[ba]: https://www.youtube.com/watch?v=FtutLA63Cp8

0 commit comments

Comments
 (0)