Usage

Understanding illust-id

ugoira needs illust-id for download target.

First, Open pixiv page of the ugoira you want to download. Then you can see the url at url bar of browser like this.

http://www.pixiv.net/member_illust.php?mode=medium&illust_id=44522595

Look at the number after illust_id=, 44525295 is illust-id!

illust-id must be integer and must not include other characters such as & or english alphabets.

Download as GIF

You can download ugoira as GIF. If you want to download the 44525295 as GIF, type it on cmd or terminal.

$ ugoira 44525295

If you can’t find the file, type this.

$ pwd

Limitation of GIF

GIF only supports 256 colors in an image. If you download a colorful ugoira as GIF, the downloaded image will be discolored and lose some of its colors.

Download as WEBP

You can can also download ugoira as WEBP with system dependency. If you want to download the 44525295 as WEBP, at first, install webp library and type it on cmd or terminal.

$ ugoira --format=webp 44525295

If you can’t find the file, type this.

$ pwd

Known issues

  1. Generating WEBP is slower than GIF because WEBP is lossless and this tool make best quality output.
  2. Generated WEBP file seem slower than GIF file. It is problem of third-party library, pillow, and I wait for fix that. See more detail this issue on GitHub

Download as APNG

You can download ugoira as APNG with extra dependency. If you want to download the 44525295 as APNG, type it on cmd or terminal.

$ pip install ugoira[apng]
$ ugoira --format=apng 44525295

If you can’t find the file, type this.

$ pwd

Change Frame Interval

You can change interval of each frames to change animation speed with --speed option.

For example, if you want to accelerate the speed by 10x, give 10:

$ ugoira --speed 10 44525295

Download as PDF

You can download ugoira as PDF. It is collection of each frames per page. If you want to download the 44525295 as ZIP, type it on cmd or terminal.

$ ugoira --format=pdf 44525295

If you can’t find the file, type this.

$ pwd

Download as ZIP

You can download ugoira as ZIP. If you want to download the 44525295 as ZIP, type it on cmd or terminal.

$ ugoira --format=zip 44525295

If you can’t find the file, type this.

$ pwd

Change result filename and path

You can change filename and path with --dest option.

$ ugoira --dest=toramaru.gif 44525295

{}s in the option are replaced with the illust-id and format. You may find this useful when downloading multiple files at once.

$ ugoira --dest=number_{}_ugoira.{} 44525295

In the example above, the output filename would be ‘number_44525295_ugoira.gif’.

Download multiple ugoira

Simply pass multiple illust-ids:

$ ugoira 44525295 44525296