mangadesk

command module
v0.4.1 Latest Latest
Warning

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

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

README

mangadesk - Terminal client for MangaDex 📖

Go Report Card GitHub all releases

Download manga directly from your terminal to read!

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.

Usage ✍

Simply choose the chapters you want to read to download.

Download folder

By default, all downloads are stored in a folder titled downloads, relative to where you run the application.

However, you can change this by changing the downloadDir field in the usr/usr_config.json file (this file only appears after running the application at least once!).

Languages

By default, English (en) is the main language.

You may change your desired language(s) through the languages field in the usr_config.json file.

Please use comma-separated ISO language codes!

Force Port 443

Valid options for this 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 a school/office) networks. More info.

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

Installation 🔧

Check out the releases page for relevant files.

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

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

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