Skip to content

Terminal-based manga reader and downloader with image support

License

Notifications You must be signed in to change notification settings

orhun/manga-tui

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 Manga-tui 🖥️

Terminal manga reader and downloader

demo.mp4

Table of contents

Features

  • Advanced search (with filters)
filters.mp4
  • Read manga in your terminal (Wezterm, iTerm2, or Kitty, any terminal that has support for graphics protocol)
reader.mp4
  • Reading history is stored locally (with no login required)
feed.mp4
  • Download manga
download.mp4

Installation

Using cargo

cargo install manga-tui

Binary release

Download a binary from the releases page

Image rendering

Use a terminal that can render images such as Wezterm (Personally I recommend using this one It's the one used in the videos), iTerm2 or Kitty,

For more information see : image-support

No images will be displayed if the terminal does not have image support (but manga-tui will still work as a manga downloader)

Usage

After installation run the binary

manga-tui

Manga downloads and reading history is stored in the manga-tui directory, to know where it is run:

manga-tui --data-dir 

# or

manga-tui -d

On linux it will output something like: ~/.local/share/manga-tui

On the manga-tui directory there will be 3 directories

  • history, which contains a sqlite database to store reading history
  • mangaDownloads, where manga will be downloaded
  • errorLogs, for storing posible errors / bugs

If you want to change the location you can set the environment variable MANGA_TUI_DATA_DIR to some path pointing to a directory, like:

export MANGA_TUI_DATA_DIR="/home/user/Desktop/mangas"

Configuration

By default manga-tui will search mangas in english, you can change the language by running:

# `es` corresponds to the Iso code for spanish
manga-tui lang --set 'es'

Check the available languages and their Iso codes by running:

manga-tui lang --print

Motivation

I wanted to make a "How linux user does ..." but for manga, here is the video also this is a great excuse to start reading manga again

Credits

Many thanks to Mangadex for providing the free API please consider supporting them ❤️
Many thanks to the Ratatui organization for making such a good library for making TUI's in rust 🐭
Many thanks to the developer of the Ratatui-image crate for providing a widget that renders images in the terminal 🖼️

Consider giving a star to this project ⭐

About

Terminal-based manga reader and downloader with image support

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 100.0%