Skip to content

Latest commit

 

History

History
196 lines (127 loc) · 5.89 KB

README.md

File metadata and controls

196 lines (127 loc) · 5.89 KB
Raw

📖 Manga-tui 🖥️

Terminal-based manga reader and downloader written in rust 🦀

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 (available formats: cbz, epub and raw images)
download_single_chapter.mp4
  • Download all chapters of a manga (available formats: cbz, epub and raw images)
download_all_chapters.mp4

Installation

Using cargo

cargo install manga-tui --locked

AUR

You can install manga-tui from the AUR with using an AUR helper.

paru -S manga-tui

Nix

If you have the Nix package manager, this repo provides a flake that builds the latest git version from source.

Simply run the following:

nix run 'github:josueBarretogit/manga-tui'

Or, to install persistently:

nix profile install 'github:josueBarretogit/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

Warning

On windows image display is very buggy, see this issue for more information

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 just run the binary

manga-tui

Configuration

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 4 directories

  • history, which contains a sqlite database to store reading history
  • config, which contains the manga-tui-config.toml config file with the following fields:
# The format of the manga downloaded 
# values : cbz , raw, epub 
# default : cbz 
download_type = "cbz"

# Download image quality, low quality means images are compressed and is recommended for slow internet connections 
# values : low, high 
# default : low 
image_quality = "low"

# Pages around the currently selected page to try to prefetch
# values : 0-255
# default : 5
amount_pages = 5

# Whether or not bookmarking is done automatically, if false you decide which chapter to bookmark
# values : true, false
# default : true
auto_bookmark = true

if the manga-tui-config.toml cannot be read / parsed then the defaults will be used

  • mangaDownloads, where manga will be downloaded
  • errorLogs, for storing posible errors / bugs

If you want to change the location of this directory 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"

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 ⭐