flump

A simple CLI tool for mass-downloading full-quality images from Fandom wiki pages' [image galleries][1].

I wrote this mostly for my own convenience. If it's useful for anyone else, I'm glad! \_(:3」∠)\_

Contents

- Installation
- Usage
- Command-Line Options
- API

In Fandom galleries, images are usually scaled down and the URL to the full-size image is often not present in the DOM until a user clicks on the image thumbnail (opening the [image lightbox][2]). Additionally, images are also lazy-loaded most of the time.

A naive image scraper would only be able to download small, lower quality versions of images from galleries (if any at all).

This tool gets around that. It uses [puppeteer][3] and is designed to be reliable—not fast. For big pages (like [this one][4]), it can take a couple minutes to fetch every image.

Note: Images that are not part of a Fandom gallery (see [this definition][1]) are not downloaded.

Installation

This tool can be installed with NPM:
``bash
npm install -g flump
`

Usage

All you have to do is pass the URL to the wiki page as an argument:

`bash
flump "page-url-here"
`

You can also set the destination folder for the images:

`bash
flump "page-url-here" --output="folder-name"
`

$3

`
Usage: flump [options]

Fandom wiki gallery scraper.

Arguments:
url URL of a Fandom wiki page to scrape

Options:
-V, --version output the version number
-o, --output directory where images should be dumped
-q, --quiet silence log messages
-h, --help display help for command
``

API

* flump
* _static_
* .scrapeImages(url) ⇒ Promise.<Array.<string>>
* .downloadImages(url, options) ⇒ Promise.<void>
* _inner_
* ~FlumpOptions : Object

$3

Scrape a Fandom wiki page for gallery images and get their URLs.

Kind: static method of flump
Returns: Promise.<Array.<string>> - A list of image URLs as strings.

| Param | Type | Description |
| --- | --- | --- |
| url | string | URL to a Fandom wiki page. |

$3

Scrape a Fandom wiki page for gallery images and download all of them.

Kind: static method of flump

| Param | Type | Description |
| --- | --- | --- |
| url | string | URL to a Fandom wiki page. |
| options | FlumpOptions | Additional options. See FlumpOptions. |

$3

Additional options passed to downloadImages.

Kind: inner typedef of flump
Properties

| Name | Type | Description |
| --- | --- | --- |
| quiet | boolean | Silence log messages. |
| output | string | The output folder for images. |

[1]: https://community.fandom.com/wiki/Help:Galleries#Fandom_galleries
[2]: https://community.fandom.com/wiki/Help:Image_lightbox
[3]: https://github.com/puppeteer/puppeteer
[4]: https://jojo.fandom.com/wiki/Gyro_Zeppeli?so=search#Gallery