Skip to content

mangalorg/libmangal

Repository files navigation

logo depicting a cartoon octopus

libmangal β

Warning

This is a beta software. The API is not stable and may change at any time.

This is the engine for downloading, managing, tagging, reading manga with native Anilist integration. A powerful wrapper around anything that implements its Provider interface.

It's designed to be a backend for various frontends that can be built on top of it. Such as a CLI, a web app, a mobile app, gRPC server, etc. Anything!

Features

  • Smart caching - only download what you need
  • Different export formats
    • PDF - chapters stored a single PDF file
    • CBZ - Comic Book ZIP format
    • TAR - TAR archive
    • ZIP - ZIP archive
    • Images - a plain directory of images
  • Monolith - no runtime dependencies.
  • Generates metadata files
    • ComicInfo.xml - The ComicInfo.xml file originates from the ComicRack application, which is not developed anymore. The ComicInfo.xml however is used by a variety of applications.
    • series.json - A JSON file containing metadata about the series. Originates from mylar3
  • Automatically populates missing metadata by querying Anilist.
  • Filesystem abstraction - can be used with any filesystem that implements afero
    • Remote filesystems
    • In-memory filesystems
    • etc.
  • Highly configurable
    • Define how you want to name your files
    • Define how you want to organize your files
    • Define how you want to tag your files
    • Define how you want to cache your files
  • Cross-platform - every OS that Go compiles to is supported
    • Windows
    • Linux
    • MacOS
    • WASM
    • etc.

Install

go get github.com/mangalorg/libmangal@latest

Providers

Apps using libmangal

  • mangalcli - Advanced Manga Downloader with Anilist integration, metadata generation and Lua extensions.

About

🐙 Engine for downloading, managing, tagging, reading manga with native Anilist integration.

Resources

License

Stars

Watchers

Forks

Packages

No packages published