Skip to content

leotaku/kojirou

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Header Image

Kojirou Go Report Card Github CI Status GitHub Wiki Status

Generate perfectly formatted Kindle e-books from MangaDex manga

Features

Download manga and generate Kindle e-books

Kojirou will automatically download the series for the specified ID and language while outputting a folder with all the downloaded volumes.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en

Generate Kindle folder structure for easy synchronization

Kojirou can also output a folder structure matching that of any modern Kindle device to allow for easy synchronization using e.g. rsync.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --kindle-folder-mode
udisksctl mount -b /dev/sdb
rsync kindle/ /run/media/user/Kindle/

Customize ranking for better scantlations

Kojirou has the ability to use different ranking algorithms in order to always download the highest-quality scantlations. You can preview what would be downloaded by running in dry-run mode.

Note: Currently, the views and views-total ranking algorithms are broken because MangaDex no longer provides the required viewcount information.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --rank newest --dry-run
kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --rank most

Load chapters from the filesystem

Kojirou has the ability to load chapters from your local filesystem. This can be useful if certain chapters are not available on MangaDex, or you want to convert your existing collection. Chapters found locally are always preferred, even if they are also available on MangaDex.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --disk /path/to/directory

The directory structure should follow the following pattern. Sorting of volumes, chapters and pages is done numerically and an arbitrary number of leading zeros is supported.

  • root/
    • 01/ :: Volume
      • cover.{jpeg,jpg,png,bmp} :: Volume cover (optional)
      • 01: Title/ :: Chapter (with optional title, use colon ":")
        • 01.{jpeg,jpg,png,bmp} :: Page

Crop whitespace from pages automatically

Kojirou has the ability to crop whitespace from the borders of manga pages. This may be useful if your e-reader has a small screen.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --autocrop

Change reading direction

Kojirou, by default, generates e-books with right-to-left reading direction, as this is the default convention for most manga. Also note that right-to-left reading does not seem to be supported on all Kindle devices.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --left-to-right

Fill volume number in title

Kojirou has the ability to fill the volume number in e-book titles with an arbitrary number of leading zeros. This is useful because Kindle devices sort titles alphabetically without any special handling of numbers. So, for example, volume "2" would be placed before "10", while "02" would be correctly sorted.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --fill-volume-number 2

Use lower quality images to save space

Kojirou has the ability to download lower-quality images from MangaDex. This can be useful to save space on your device, or to reduce the amount of data downloaded on slow or limited connections. Legal arguments to this option are "no", "prefer" and "fallback".

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --data-saver=prefer

Fallback to lower quality alternatives for broken images

MangaDex sometimes hosts images that are subtly broken and cannot be reliably converted to an image format compatible with Kindle devices. Kojirou can be configured to fall back on reencoded lower-quality versions of these images, which often do not have the same problems.

kojirou d86cf65b-5f6c-437d-a0af-19a31f94ec55 -l en --data-saver=fallback

Prebuilt binaries

Prebuilt binaries for Linux, Windows and MacOS on x86 and ARM processors are provided. Visit the release tab to download the archive for your respective setup.

On Linux and MacOS you will have to make the provided binary executable after extracting it from the archive.

chmod u+x ./kojirou.exe

Afterwards, verify your installation succeeded by executing the application on the command line.

./kojirou.exe --version

Install from source

Kojirou can be installed from source easily if you already have access to a Go toolchain. Otherwise, follow the Go installation instructions for your operating system, then execute the following command.

go install github.com/leotaku/kojirou@latest

Afterwards, verify your installation succeeded by executing the application on the command line.

kojirou --version

On many systems, the Go binary directory is not added to the list of directories searched for executables by default. If you get a "command not found" or similar error after the previous command, run the following command and try again. If you are using Windows, please find out how to add directories to the lookup path yourself, as there does not seem to be any quality documentation that I could link here.

export PATH="$PATH:$(go env GOPATH)/bin"

License

MIT © Leo Gaskin 2020-2024