📖 Manga-tui 🖥️
Terminal-based manga reader and downloader written in rust 🦀
https://github.com/user-attachments/assets/2b693bd3-ec30-4d6e-bcc4-6cf457a860b1
Table of contents
Features
https://github.com/user-attachments/assets/c1e21aa1-8a51-4c47-baea-9f56dcd0d6a4
- Read manga in your terminal with terminals such as: Wezterm, iTerm2, Kitty, Ghostty
https://github.com/user-attachments/assets/70f321ff-13d1-4c4b-9c37-604271456ab2
- Reading history is stored locally (with no login required)
https://github.com/user-attachments/assets/47e88e89-f73c-4575-9645-2abb80ca7d63
- Download manga (available formats: cbz, epub, pdf and raw images)
https://github.com/user-attachments/assets/ba785668-7cf1-4367-93f9-6e6e1f72c12c
- Download all chapters of a manga (available formats: cbz, epub, pdf and raw images)
https://github.com/user-attachments/assets/26ad493f-633c-41fc-9d09-49b316118923
Join the discord server for further help, feature requests or to chat with contributors
Dependencies
On linux you may need to install the D-bus secret service library
Debian
sudo apt install libdbus-1-dev pkg-config
Fedora
sudo dnf install dbus-devel pkgconf-pkg-config
Arch
sudo pacman -S dbus pkgconf
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, Kitty and Ghostty
For more information see: image-support
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
Manga providers
Expect any manga provider to fail at some point, either due to them closing operations due to a lawsuit or the provider itself having issues on their end like manganato
By default when you run manga-tui Mangadex will be used
manga-tui
If you want to use Weebcentral or any other provider available then run:
manga-tui -p weebcentral
Configuration
The config file is located at XDG_CONFIG_HOME/manga-tui/config.toml, to know where it is you can run:
manga-tui --config-dir
# or
manga-tui -c
Which provides the following configuration:
# The format of the manga downloaded
# values: cbz, raw, epub, pdf
# 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
# Whether or not downloading a manga counts as reading it on services like anilist
# values: true, false
# default: false
track_reading_when_download = false
# Enable / disable checking for new updates
# values: true, false
# default: true
check_new_updates = true
# Sets which manga provider will be used when running manga-tui,
# you can override it by running manga-tui with the -p flag like this: manga-tui -p weebcentral
# values: mangadex, weebcentral, mangapill
# default: "mangadex"
default_manga_provider = "mangadex"
# Enable / disable tracking reading history with services like `anilist`
# values: true, false
# default: true
track_reading_history = true
# Anilist-related config, if you want `manga-tui` to read your anilist credentials from this file then place them here
[anilist]
# Your client id from your anilist account
# leave it as an empty string "" if you don't want to use the config file to read your anilist credentials
# values: string
# default: ""
client_id = ""
# Your acces token from your anilist account
# leave it as an empty string "" if you don't want to use the config file to read your anilist credentials
# values: string
# default: ""
access_token = ""
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 historymangaDownloads, where manga will be downloadederrorLogs, 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"
[!NOTE]
Mangadex-only feature
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'
[!NOTE]
Mangadex-only feature
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 ⭐
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
评论