Welcome to Manrododex’s documentation!

Getting started

Installing Manrododex

From PyPI

  • First time install : pip install manrododex

  • Updating : pip install --upgrade manrododex

From Source

  1. Clone the repo : git clone https://github.com/Sydiepus/Manrododex.git

  2. Go into the folder : cd Manrododex

  3. Install with : pip install .

Compatibility

Python interpreters

The program is tested against 4 different versions : 3.7, 3.8, 3.9 and 3.10. The program should work on these, in case of any errors please open an issue on github.

Windows/Mac OS/Android

I haven’t tested it on Windows/Mac OS/Android yet, please report any issues. Even though i haven’t used any platform specific functions/libraries bugs are to be expected.

Linux

This is the platform that the program was developed on, it works nicely i suppose. Again Bugs are to be expected.

IOS

Tested on iSH Shell. The progress bar is broken, i’ll try to add an options to disable it and to disable the chapter archiving to make reading the chapters easier.

Using a file to download

A file can be used to download manga with manrododex -F file
The file should contain one entry per line, the syntax is as follows :
the url or uuid, a custom name, language

  • the custom name and language can be omitted, however to change the language without changing the name you still have to add 2 commas, one for the name and another for the language.

  • example of a file:

e1d0056a-fdd3-4f32-af19-50eeb37280ac
https://mangadex.org/title/9643f5da-c7da-4705-ac5b-4b4a4c7a649e/gleipnir
https://mangadex.org/title/259dfd8a-f06a-4825-8fa6-a2dcd7274230/yofukashi-no-uta, call of the night,
https://mangadex.org/title/aa6c76f7-5f5f-46b6-a800-911145f81b9b/sono-bisque-doll-wa-koi-wo-suru, Cosplay doll, br
https://mangadex.org/title/267db3f7-fd9c-4395-ac36-9ffacd772473/star-martial-god-technique,,
3f28c47a-bf8d-4e79-83ca-2e64fe906372,,jp

  • When no language is given english is going to be used.

  • When no custom name is given the default title (the one that appears on the site) will be used unless specified otherwise with the --use-alt-title

Arguments

usage: manrododex [-h] [-F [FILE]] [--version] [--log-level LOGLVL]
                  [--lang-codes] [--dry-run] [-p PATH] [-t THREADS] [-l LANG]
                  [-ds] [-svc SEL_VOL_CHAP] [--alt-title-lang ALT_TITLE_LANG]
                  [--use-alt-title] [--name NAME] [--force-ssl] [--zip-format]
                  [URL_UUID]

Positional Arguments

URL_UUID

URL_UUID, i.e. link or uuid of the manga to be downloaded.

Named Arguments

-F, --File

FILE, i.e. folder containing the links or uuids of the mangas to be downloaded.

General options

--version

Shows manrododex’s version and exit.

--log-level

Set the log level. Default log file location /tmp/manrododex.log possible values : ‘DEBUG’ ‘INFO’ ‘WARNING’ ‘ERROR’ ‘CRITICAL’

Default: INFO

--lang-codes

Prints the available language codes and exit.

Default: False

--dry-run

Run the program without creating/saving anything.

Default: False

Downloading options

-p, --path

Destination folder: where the manga will be saved. The path will be ‘./PATH/manga_name/’

Default: “/home/docs/checkouts/readthedocs.org/user_builds/manrododex/checkouts/latest/docs/Manga”

-t, --threads

Sets the number of threads to be used. Aka the number of images to be downloaded in parallel. Please don’t use a lot of threads as it might get you banned.

Default: 1

-l, --language

Set the language in which the chapters should be downloaded with.

Default: en

-ds, --data-saver

Switch the quality mode from ‘data’ to ‘data-saver’. ‘data-saver’ will download a compressed image instead of upload quality.

Default: “data”

-svc, --sel-vol-chap

Select chapters to be downloaded can be singles separated by ‘,’ use ‘v{num}v’ to mark the number as volume.

‘/’ to make a range. ‘,’ to start a new rule.

e.g: v7v99 would be volume 7 chapter 99.

v1/3v1 would be chapter 1 from vol 1, 2 and 3. 1,4,6 would download chapter 1, 4 and 6 regardless for the volume. v6v would download volume 6 entirely.

--alt-title-lang

Specify the language in we should get the alternative title. Available alternative titles can be seen to the left of the chapters of the manga on the site.

--use-alt-title

Whether or not to use the alternative title of the manga. Aka the one that appears to the side of the chapters on the site. Note: this argument can be used with –alt-title-lang to change the language of the alt title. If this argument is not used the program will get the default title even ifthe –alttitle-lang is used.

Default: False

--name

Set a custom name for the manga. Note: this argument precedes the both of the –alttitle-lang and –deftitle in importance

--force-ssl

Force selecting from MangaDex@Home servers that use the standard HTTPS port 443. from https://api.mangadex.org/swagger.html

Default: False

--zip-format

The use of this argument will switch it to zip. By default the cbz archive format will be used.

Default: “cbz”

Miscellaneous

Frequently Asked Questions

Well I’m lying, no one asked any of these question and I don’t even known if there’s a single person that is going to read this documentation or use my program but i think writing documentation is good practice. (Hire me senpai >_<)

Why the name Manrododex ?

Well it’s a combination of three different words : Man/rodo/dex

  1. Man: for Manga.

  2. rodo: for the load part of download in japanese ダウンロード which is ロード in katakana or rōdo in romaji.

  3. dex: for the dex in MangaDex

Joining all these information we get : Manga daunrodo dex, which makes no sense.

What is a UUID ?

From wikipedia UUID: Universally unique identifier, A universally unique identifier is a 128-bit label used for information in computer systems. The term globally unique identifier is also used. When generated according to the standard methods, UUIDs are, for practical purposes, unique.

Putting it simply it’s a text made of letters and numbers separated by - and is unique.
An example would be : 17876b69-42a2-4228-aeda-f8e14f4f94f4
How does this relate to MangaDex ?

Well MangaDex uses UUIDs as a way to uniquely identify mangas, and is used by the program to download the manga that you want.

What are you talking about ? I never saw that thing on MangaDex ?
Maybe you don’t pay enough attention to links in your browser.
It’s right there:
_images/uuid_in_the_wild.png

What’s the default title ?

It’s the title writen in white, big enough for you not to miss it.
Here:
_images/default_title.png

What’s the alt title ?

alt title or Alternative Title is the non default title usually in a different language than the default one.
MangaDex write the english alt title for the manga under the default one like this:
_images/alt_title.png
Other Alternative Titles are writen to the left of the chapters like this:
_images/alt_titles.png

License

This project is distributed under the MIT License.

Copyright (c) 2022 Charbel Assaad.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.