mapaki

command module
v0.0.0-...-c9f473c Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2023 License: MIT Imports: 1 Imported by: 0

README

Mapaki

Mapaki is a no-brainer manga packer for kindle.

Workflow and usage

  1. Use HakuNeko to download manga to your computer.
  2. Run the following command on the downloaded mangas' directory.
    mapaki -i "./Manga Name"
    
    This command will generate a single Manga Name.azw3 file as its output.
  3. Use Calibre to upload generated file to your Kindle device.

Mapaki features

Automatic chapter discovery
  • It will automatically figure out the file system layout of the downloaded manga.
  • The names of the chapters, volumes, pages and covers do not have to follow any special convention. They will be "naturally sorted" (read more) while respecting the directory layout and the "images before subdirectories" convention, to ensure that the title and volume covers are put at the beginning of the chapters.
  • Corrupted images and non-image files will be skipped. However, their paths will be printed to the console.
Auto cropping

By default, Mapaki will crop out white space around all images. Auto cropping can be disabled via following flag --disable-auto-crop=true.

Full screen images

Images fill the screen. There's no top or bottom margin, no padding, no stretching.

Auto double page handling

By default, Makapi will ensure that every double page is displayed firstly "as is", followed by the page's right side, and lastly, followed by the page's left side. This behaviour can be changed via the following flag --double-page [mode]:

  • --double-page only-double
  • --double-page only-split
  • --double-page split-then-double
  • --double-page double-then-split (default)

Install

Mapaki 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/tsopeh/mapaki@latest

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

mapaki --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"

Thanks

Many thanks to Leo Gaskin (@leotaku) 🎉. This project was inspired and heavily influenced by his work on kojirou. Some code (e.g. the crop module, image template string, the "install step" in this readme) has been copied directly from kojirou. Leo also developed the mobi library for Go, that handles packing of the images into the .azw3 file.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

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