mandlemankiller / conquade

Linux terminal video player

Conquade video player

A video player designed to play videos in the linux console.

Requirements

• Terminal that supports at least 256 colors (true color is better)
• Java 17
• ffmpeg

Known problems

• Video lags and sometimes desyncs with audio
• Videos that contain raw audio larger than 2.1GB can't be played

Showcase

Usage

If you want to view usage the terminal-like way, go here.

Required parameters are marked with *.

conquade.jar <action> <params>

Global args

• -debug   enable debug (verbose) mode
• -tmp   set the conquade temporary folder (default: /tmp/conquade | %USER%\AppData\Local\Temp\conquade)
• -ffmpeg   set path to the ffmpeg executable (default: ffmpeg)
• -256   use 256 color space instead of true color (256 ^ 3)

Help

conquade.jar help <args>   print usage information

Render

conquade.jar render <args>   render a video file to a conquade file

Render args

• *-i   input video file path
• *-o   output conquade file path (should end with .cqd file extension)
• -fps <number>   set the rendering fps (default: 30), it must be true that "0 < fps < 256"
• -force   overwrite output file if it already exists
• -noaudio   do not render audio, even if it is present (must be used for videos without an audio track)

Play

conquade.jar play <args>   play a prerendered conquade file

Play args

• *-i   input conquade file path
• -noaudio   do not play audio, even if it is present
• -nores   ignore resolution mismatch (when the rendered video size is different from the terminal size)
• -color <target>   set the color target (default: text_only)
  • text_only   print only colored text
  • highlight_only   do not print text, print only colored highlight
  • black_text   print black text and colored highlight

Stream

conquade.jar stream <args>   stream (play) a video without prerendering it

Stream args

• *-i   input video file path
• -fps   set the streaming fps (default: 30), it must be true that "0 < fps < 256"
• -noaudio   do not stream audio, even if it is present (must be used for videos without an audio track)
• -color <target>   set the color target (default: text_only)
  • text_only   print only colored text
  • highlight_only   do not print text, print only colored highlight
  • black_text   print black text and colored highlight

Examples

• Render a video at 50 FPS:
  java -jar conquade.jar render -i ~/Videos/shrek.mp4 -o ~/Videos/shrek.cqd -fps 50
• Play a prerendered video:
  java -jar conquade.jar play -i ~/Videos/shrek.cqd
• Play a prerendered video without sound:
  java -jar conquade.jar play -i ~/Videos/shrek.cqd -noaudio
• Stream a video at 50 FPS with a different ffmpeg executable:
  java -jar conquade.jar stream -i ~/Videos/shrek.mp4 -fps 50 -ffmpeg /opt/ffmpeg-6.1.1/ffmpeg

Build

Requires Maven

git clone https://github.com/Mandlemankiller/Conquade.git
cd Conquade
mvn package

The jar file is located in Conquade/target/Conquade-1.0-SNAPSHOT-jar-with-dependencies.jar