Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akianonymus/mangadl-bash
Search and batch download mangas straight in terminal.
https://github.com/akianonymus/mangadl-bash
bash batch-downloading fanfox gmanga linux macos manga manga-downloader manga-scraper mangafox mangahub mangakakalot manganelo parallel-downloads readmanhwa
Last synced: 21 days ago
JSON representation
Search and batch download mangas straight in terminal.
- Host: GitHub
- URL: https://github.com/akianonymus/mangadl-bash
- Owner: Akianonymus
- License: unlicense
- Created: 2020-06-17T03:47:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T09:15:20.000Z (about 2 years ago)
- Last Synced: 2023-04-25T17:40:02.775Z (over 1 year ago)
- Topics: bash, batch-downloading, fanfox, gmanga, linux, macos, manga, manga-downloader, manga-scraper, mangafox, mangahub, mangakakalot, manganelo, parallel-downloads, readmanhwa
- Language: Shell
- Homepage:
- Size: 202 KB
- Stars: 37
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Manga Downloader
> mangadl-bash is a collection of bash compliant scripts to download mangas from different sources.
- Minimal
- Search and download mangas
- Resume Interrupted downloads
- Easily batch download mangas
- Parallel downloading
- Pretty logging
- Easy to install and update
- Self update
- [Auto update](#updation)
- Can be per-user and invoked per-shell, hence no root access required or global install with root access.
## Supported sources
- Manganelo / Mangakakalot
- Mangafox / Fanfox
- Readmanhwa
- Manga4life
- Gmanga
## Table of Contents
- [Compatibility](#compatibility)
- [Linux or MacOS](#linux-or-macos)
- [Android](#android)
- [iOS](#ios)
- [Windows](#windows)
- [Installing and Updating](#installing-and-updating)
- [Native Dependencies](#native-dependencies)
- [Installation](#installation)
- [Basic Method](#basic-method)
- [Advanced Method](#advanced-method)
- [Additional notes for installation](#additional-notes-for-installation)
- [Updation](#updation)
- [Usage](#usage)
- [Download Script Custom Flags](#download-script-custom-flags)
- [Multiple Inputs](#multiple-inputs)
- [Resuming Interrupted Downloads](#resuming-interrupted-downloads)
- [Uninstall](#Uninstall)
- [Reporting Issues](#reporting-issues)
- [Adding new sources](#adding-new-sources)
- [Contributing](#contributing)
- [License](#license)
## Compatibility
As this repo is bash compliant, there aren't many dependencies. See [Native Dependencies](#native-dependencies) after this section for explicitly required program list.
### Linux or MacOS
For Linux or MacOS, you hopefully don't need to configure anything extra, it should work by default.
### Android
Install [Termux](https://wiki.termux.com/wiki/Main_Page).
Then, `pkg install curl wget` and done.
Install convert too if you are going to use -c/--convert flag.
It's fully tested for all usecases of this script.
### iOS
Install [iSH](https://ish.app/)
While it has not been officially tested, but should work given the description of the app. Report if you got it working by creating an issue.
### Windows
Use [Windows Subsystem](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
Again, it has not been officially tested on windows, there shouldn't be anything preventing it from working. Report if you got it working by creating an issue.
## Installing and Updating
### Native Dependencies
The script explicitly requires the following programs:
| Program | Role In Script |
| --------- | ------------------------------------------------------ |
| bash | Execution of script ( version >= 4 ) |
| curl | Network requests for fetching manga details |
| sleep | To sleep |
| wget | Downloading images |
| xargs | For parallel downloading |
| mkdir | To create folders |
| rm | To remove files and folders |
| grep | Miscellaneous |
| sed | Miscellaneous |
| zip | For creating zip ( -z / --zip option ) |
| convert | For converting images ( -c / --convert option ) |
| jq | To parse json |
| openssl | To decrypt json for gmanga |
Note: zip and convert programs are optional, if not installed, then respective flags won't work, but rest of the script functions will be fine.
### Installation
You can install the script by automatic installation script provided in the repository.
Default values set by automatic installation script, which are changeable:
**Repo:** `Akianonymus/mangadl-bash`
**Command name:** `mangadl`
**Installation path:** `$HOME/.mangadl-bash`
**Source value:** `master`
**Shell file:** `.bashrc` or `.zshrc` or `.profile`
For custom command name, repo, shell file, etc, see advanced installation method.
Note: When global install is done, then standalone script is used, and split files are used in per-user per-shell installation.
**Now, for automatic install script, there are two ways:**
#### Basic Method
To install mangadl-bash in your system, you can run the below command:
```shell
curl --compressed -s https://raw.githubusercontent.com/Akianonymus/mangadl-bash/master/release/install | bash -s
```
and done.
#### Advanced Method
This section provides information on how to utilise the install script for custom usescases.
These are the flags that are available in the install script:
Click to expand
- -p | --path
Custom path where you want to install the script.
---
- -c | --cmd
Custom command name, after installation, script will be available as the input argument.
---
- -r | --repo
Install script from your custom repo, e.g --repo Akianonymus/mangadl-bash, make sure your repo file structure is same as official repo.
---
- -B | --branch
Specify branch name for the github repo, applies to custom and default repo both.
---
- -s | --shell-rc
Specify custom rc file, where PATH is appended, by default script detects .zshrc, .bashrc. and .profile.
---
- -t | --time 'no of days'
Specify custom auto update time ( given input will taken as number of days ) after which script will try to automatically update itself.
Default: 5 ( 5 days )
---
- --skip-internet-check
Do not check for internet connection, recommended to use in sync jobs.
---
- -q | --quiet
Only show critical error/sucess logs.
---
- -U | --uninstall
Uninstall the script and remove related files.\n
---
- -D | --debug
Display script command trace.
---
- -h | --help
Display usage instructions.
---
Now, run the script and use flags according to your usecase.
E.g:
```shell
curl --compressed -s https://raw.githubusercontent.com/Akianonymus/mangadl-bash/master/release/install | bash -s -- -r username/reponame -p somepath -s shell_file -c command_name -B branch_name
```
### Additional notes for installation
The system wide installation script run for two modes, global and non-global installation.
#### Global
In global installation, standalone script from release/standalone folder is used. For global installation, use --path flag with installation script.
Given path should be present in ${PATH} variable and should be outside of ${HOME} directory.
#### Non Global
In non-global installtion, split minified files are used from release/split folder. No additional flag is necessary for this.
It will be installed in user ${HOME} directory.
**Note: It is recommended to use non-global installation because it supports incremental updates, so each update will only fetch what's updated, rather than all the scripts. Otherwise, both installations are fine.**
### Updation
If you have followed the automatic method to install the script, then you can automatically update the script.
There are two methods:
1. Use the script itself to update the script.
`mangadl -u or mangadl --update`
This will update the script where it is installed.
If you use the this flag without actually installing the script,
e.g just by `bash mangadl.bash -u` then it will install the script or update if already installed.
1. Run the installation script again.
Yes, just run the installation script again as we did in install section, and voila, it's done.
**Note: Above methods always obey the values set by user in advanced installation,**
**e.g if you have installed the script with different repo, say `myrepo/mangadl-bash`, then the update will be also fetched from the same repo.**
## Usage
After installation, no more configuration is needed.
`mangadl manga_name/manga_url`
Script supports argument as mangaurl, or a manga_name.
Incase of mangaurl, it should be in supported providers, see utils folder for all providers.
Incase of search term, it will searched in the remote database and show results, choose accordingly and proceed.
Now, we have covered the basics, move on to the next section for some super useful features and usage, like specifying range, parallel downloads, etc.
### Download Script Custom Flags
These are the custom flags that are currently implemented:
- -d | --directory
Custom workspace folder where new mangas will be downloaded.
---
- -s | --source 'name of source'
Source where the input will be searched. See available sources in utils folder.
To change default source, use mangadl -s default=sourcename
---
- -n | --num 'no of searches to show'
No. of searches to show, default is 10.
To change default no of searches, use mangadl -n default='no of searches'\n
---
- -p | --parallel
Download multiple files in parallel.
Note:
- This command is only helpful if you are downloding many files which aren't big enough to utilise your full bandwidth, using it otherwise will not speed up your download and even error sometimes,
- 5 to 10 value is recommended. If errors with a high value, use smaller number.
- Beaware, this isn't magic, obviously it comes at a cost of increased cpu/ram utilisation as it forks multiple bash processes to download ( google how xargs works with -P option ).
---
- -r | --range 'ranges'
Note: Arguments are optional
Custom range, can be given with this flag as argument, or if not given, then will be asked later in the script.
If range is given with flag as an argument, the it is taken as postion of chapter of a specific manga.
e.g: -r '1 5-10 11 15-last last', this will download chapter number 1, 5 to 10 and 11.
Note:
- 15-last type of range will pick from 15th number chapter to last.
- If just last is given, then it will download last chapter.
- In-case of 1-10 type of range, if last number ( i.e 10 ) exceeds total number of chapters, then all the rest chapters will be downloaded.
---
- -ra | --range-absolute 'ranges'
Everything same as `-r | --range` flag except it uses the given range as the absolute number present on the respective website.
For example some website have a chapter name 10.1, but if counted, then it would be 11th number chapter, then this flag comes in handy.
- -c | --convert 'quality between 1 to 99'
Decrease quality of images by the given percentage using convert ( imagemagick ) .\n
Note: Output images are converted to jpg.
---
- -z | --zip
Create zip of downloaded images.
---
- --upload
Upload created zip on pixeldrain.com.
---
- --skip-internet-check
Do not check for internet connection, recommended to use in sync jobs.
---
- -u | --update
Update the installed script in your system, if not installed, then install.
---
- --uninstall
Uninstall the installed script in your system.
---
- --info
Show detailed info, only if script is installed system wide.
---
- -h | --help
Display usage instructions.
---
- -D | --debug
Display script command trace.
---
### Multiple Inputs
You can use multiple inputs without any extra hassle.
Pass arguments normally, e.g: `mangadl manga1 manga2 manga_url1 manga_url2`
where manga1 and manga2 is manganame and rest two are urls of manga.
### Resuming Interrupted Downloads
Downloads interrupted either due to bad internet connection or manual interruption, can be resumed from the same position.
You can interrupt many times you want, it will resume ( hopefully ).
It will not download again if image is already present, thus avoiding bandwidth waste.
## Uninstall
If you have followed the automatic method to install the script, then you can automatically uninstall the script.
There are three methods:
1. Automatic updates
By default, script checks for update after 3 days. Use -t / --time flag of install script to modify the interval.
1. Use the script itself to uninstall the script.
`mangadl --uninstall`
This will remove the script related files and remove path change from shell file.
1. Run the installation script again with -U/--uninstall flag
```shell
curl --compressed -s https://raw.githubusercontent.com/Akianonymus/mangadl-bash/master/release/install | bash -s -- --uninstall
```
Yes, just run the installation script again with the flag and voila, it's done.
**Note: Above methods always obey the values set by user in advanced installation.**
## Reporting Issues
| Issues Status | [](https://GitHub.com/Akianonymus/mangadl-bash/issues/) | [](https://GitHub.com/Akianonymus/mangadl-bash/issues?q=is%3Aissue+is%3Aclosed) |
| :-----------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
Use the [GitHub issue tracker](https://github.com/Akianonymus/mangadl-bash/issues) for any bugs or feature suggestions.
### Adding new sources
If you want support for a new source, then make a new issue along with the site url.
## Contributing
| Total Contributers | [](https://GitHub.com/Akianonymus/mangadl-bash/graphs/contributors/) |
| :----------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Pull Requests | [](https://GitHub.com/Akianonymus/mangadl-bash/issues?q=is%3Apr+is%3Aopen) | [](https://GitHub.com/Akianonymus/mangadl-bash/issues?q=is%3Apr+is%3Aclosed) |
| :-----------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
Submit patches to code or documentation as GitHub pull requests. Make sure to run merge.bash and format.bash before making a new pull request.
If using a code editor, then use shfmt plugin instead of format.bash
All shellcheck warnings should also successfully pass, if needs to be disabled, proper explanation is needed.
## License
[UNLICENSE](https://github.com/Akianonymus/mangadl-bash/blob/master/LICENSE)