Comics / Manga Downloader Extension

A cross browser extension to download comics / manga as pdf file from any site!
How to use »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. How To Use
3. Getting Started
   • Installation
     • Google Chrome
     • Firefox
   • Development Setup
     • Prerequisites
     • Setting up
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A simple cross browser extension to download comics / manga as pdf file from any site.

Although this extension was created to download comics / manga, it will also work on any website which has <img> or <canvas> attribute.

(back to top)

How to use

• Visit any website.
• Let all the images load completely.
• Click on the extension icon to open the extension popup.
• Select the images you want to include in your output pdf.
• Set a file name and select a download method and click on "Download" button.
• If you select "Direct Download", then pdf will be automatically downloaded.
• If you select "Built In Browser", then it will open the default browser print popup.
• Select "Destination" - "Save as pdf".
• Click on "More setting".
• Set "Margins" - "None".
• Finally click on "Save" button to save the pdf file.

(back to top)

Getting Started

Installation

• Visit releases page
• Download the binary file from the latest release.
• Unzip the downloaded file

Google Chrome

• Open Google chrome and visit - chrome://extensions page
• Turn on "Developer mode"
• Click on "Load Unpacked" and select the unzipped folder.

• To pin the extension on tool bar click on extensions icon and then click on pin icon next to the extension

Firefox

• Open Firefox and visit - about:debugging#/runtime/this-firefox page
• Click on "Load Temporary Add-on..." button
• Select "manifest.json" file inside of the unzipped folder.

Please note that firefox will remove the extension if you restart the browser

Development Setup

Please read the following to setup the project locally for development.

Prerequisites

• Install node
• Install Webpack

   npm install -g webpack

Setting up

1. Clone the repo

   git clone https://github.com/saptarshimondal/Comics-Manga-Downloader-Extension.git

2. Install NPM packages

   npm install

3. To start developing run -

   npm run dev

   It will bundle the project under "dist" directory and watch for any code modification.

   If you don't want to start the watcher, then run -

   npm run start

   It will just bundle the project under "dist" directory without running the watcher.

4. If you want to run the project on chrome, then you have to visit chrome://extensions page and reload the extension manually to update the latest code changes.

5. If you want to run the project on firefox, then you can run -

   npm run ext

   It will open firefox browser automatically with the extension pre installed and watch for any code changes. If you change anything in code then the extension will be reloaded automatically.

6. If you want to pack the extension, then you can run -

   npm run pack-ext

   It will create a .zip file under "web-ext-artifacts" directory. You can use this to distribute your extension.

(back to top)

Roadmap

• Filtering images by url
• Add select all checkbox
• Add "Direct download" feature
• Migrate to Manifest v3

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Saptarshi Mondal - @Saptarshi_77 - mondalsaptarshi7@gmail.com

Project Link: https://github.com/saptarshimondal/Comics-Manga-Downloader-Extension

Follow me on GitHub - saptarshimondal

(back to top)

Acknowledgments

• Chrome Extension Webpack Boilerplate
• Web extensions webpack boilerplate
• Readme template

(back to top)