mangadesk

command module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2021 License: MIT Imports: 8 Imported by: 0

README

mangadesk - Terminal client for MangaDex 📖

Top Language Go Report License Downloads

Download manga directly from your terminal to read!

demo.gif

This client retrieves information straight from MangaDex v5's API.
As the API is still a WIP, some changes (probably breaking) might be expected.

Features ✨

  • Download chapters straight to your computer.
  • Login to keep track of your followed manga.
  • Keep track of already downloaded manga.
  • Download multiple chapters together.
  • Searching!
  • Responsive UI (kind of)
  • Written in Golang :)

Works for Windows/Linux/macOS.

Installation 🔧

Check out the releases page for relevant files. To update, just download the latest release.

For bleeding edge 🗡 updates, you may compile from source:

git clone https://github.com/darylhjd/mangadesk.git
cd mangadesk
go get -d ./...
go build

Usage ✍

Simply choose the chapters you want to read to download.

Keybindings ⌨
Operation Binding Page
Login/Logout Ctrl + L All
Keybindings/Help Ctrl + K All
Search Ctrl + S All
Next/Prev Page Ctrl + F/B Some
Escape Esc Some
Select multiple chapters Ctrl + E Manga Page
Toggle select all Ctrl + A Manga Page

Settings ⚙

You may change the appropriate settings in the usr_config.json file.

You can find this file in the usr folder which is located relative to where you run the application.

Download Folder
  • downloadDir

By default, all downloads are stored in a folder titled downloads.

You can change this by changing the downloadDir field.

Languages
  • langauges

By default, only English (en) translated chapters are shown.

You may change your desired language(s) through the languages field. Please use comma-separated ISO language codes.

Download Quality
  • downloadQuality

Valid options are data (high quality) and data-saver (lower quality).

Any other empty/invalid option will default to data.

Force Port 443
  • forcePort443

Valid options are true or false. It is false by default.

Set to true if you are having trouble downloading or are using networks that block traffic to non-standard ports (such as school/office networks). More info.

Issues ☠

Check out the Issues page for current issues/feature requests.

Contributing 🤝

Always welcome and appreciated :)

Please take some time to familiarise yourself with the contributing guidelines.

Learning points 🧠

  • Creating TUIs with tview/tcell.
  • Working with the filesystem in Golang.
  • Goroutines & Context.
  • Go Project structure.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL