termplay - GitLite

KO | EN

gitlite — search

#python #react #ai #typescript #golang #android #rust #deep-learning #nodejs #windows #awesome #awesome-list #vue #pytorch

termplay

(★ 550)

GitLab: https://gitlab.com/jD91mZM2/termplay

File Explorer

Download Latest Version (.zip)

- - color256.rs
  - halfblock.rs
  - mod.rs
  - sixel.rs
  - truecolor.rs
- interactive.rs
- lib.rs
- main.rs
- resizer.rs
- zoomer.rs
.envrc
.gitignore
.gitlab-ci.yml
Cargo.lock
Cargo.toml
flake.lock
flake.nix
LICENSE
README.md
shell.nix

# Installation Guide

1. Get the code

git clone https://github.com/jD91mZM2/termplay

Downloads the entire project code from GitHub to your computer.

cd termplay

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.
APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.

cargo install termplay --features bin

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install termplay --no-default-features --features "bin,..."

Builds and installs the package published on crates.io — no need to clone the repo yourself.

sudo apt install libopenal-dev libsndfile1-dev libsixel-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install termplay --features bin

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install termplay --no-default-features --features "bin,..."

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# termplay
*Name by the awesome [@tbodt](https://github.com/tbodt)*

Are you a terminal fanboy like me?  
Sure, but do you ever watch YouTube? In your terminal?

----------------------------------------------------

`termplay` is the tool to convert images to ANSI sequences.  
But it also supports playing videos...  
Written in the systems language Rust, it has some solid performance.

- **Multiple modes**
    - Sixels: Only supported by a few terminals, like xterm.
    - Unicode halfblock: This is the same as TrueColor below, but uses unicode half-blocks for smaller pixels.
    - TrueColor: Any RGB color, supported by most terminals.
    - 256 color: The closest representation of a color that can be fit within 1 byte. Use this if nothing else works.
  - **Flexible**
    - Change framerate, size and more using command line switches
  - **Adapting size**
    - Automatically scales the image to fit your terminal

Termplay also allows you to control the media, such as zoom in or pause the video.

- **Mouse Scroll / +/-**: Zoom
  - **Mouse Drag / W/A/S/D**: Pan
  - **Space**: Play/Pause
  - **Left/Right**: Seek
  - **Up/Down**: Volume
  - **q / Ctrl+C**: Quit

![Example image](https://i.imgur.com/54MXrSk.png)  
*(Landscape image from [pexels.com](https://www.pexels.com/photo/beautiful-holiday-lake-landscape-358482/))*

## Using

### Image

```
termplay 2.0.0
jD91mZM2 <me@krake.one>
Play images/videos in your terminal

USAGE:
    termplay [FLAGS] [OPTIONS] <path>

FLAGS:
        --help       Prints help information
    -q, --quiet      Ignores all the nice TUI things for simple image viewing
    -V, --version    Prints version information

OPTIONS:
    -c, --converter <converter>    Decides how the image should be displayed [default: halfblock]  [possible values:
                                   color256, halfblock, sixel, truecolor]
    -h, --height <height>          Sets the height (defaults to the terminal size, or 24)
    -r, --rate <rate>              Sets the framerate [default: 24]
        --ratio <ratio>            Sets the terminal font ratio (only takes effect with some converters)
    -w, --width <width>            Sets the width (defaults to the terminal size, or 80)

ARGS:
    <path>    Specifies the path to the image/video to play
```

## Compiling

### Compile time requirements

**Rust v1.25 or more** is required. See your Rust version with
```
rustc --version
```
Update rust with
```
rustup update stable
```

### Compiling!

Other than that, [this project is hosted on crates.io](https://crates.io/crates/termplay).  
So to install you just need to run
```
cargo install termplay --features bin
```

(Note: The `--features` part is a hack because binaries don't allow specifying separate dependencies)

### Features

Almost all dependencies are optional and can be disabled!

Default features:

- termion: This is what enables the rich image viewer. Disabling this will disable almost everything.
  - gst: Video support, requires [gstreamer](https://gstreamer.freedesktop.org/)
  - sixel: Support for sixels, requires [libsixel](https://github.com/saitoha/libsixel)

To disable default features, run

```
cargo install termplay --no-default-features --features "bin,..."
```
where `...` is a comma separated list of features you want to keep.

### Nix

Termplay is available with the default features on Nix!

```
nix-env -iA nixpkgs.termplay
```

### Arch Linux

If you just want to get this running on Arch Linux with the default features, you can use the  
[AUR Package (unofficial)](https://aur.archlinux.org/packages/termplay/)

### Debian / Ubuntu

Example:

```
sudo apt install libopenal-dev libsndfile1-dev libsixel-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev
cargo install termplay --features bin
```