Skip to content

Commit

Permalink
Update readme.md (#1202)
Browse files Browse the repository at this point in the history
Co-authored-by: Nandaka <nchek2000@gmail.com>
  • Loading branch information
NewUserHa and Nandaka committed Jan 2, 2023
1 parent 39464b0 commit 32b0e83
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,19 +506,20 @@ Please refer run with `--help` for latest information.
Use -1 to use all tags.
- writeImageJSON

Set to `True` to export the entire original information for the image from the source to JSON.
Set to `True` to export the compact image information to JSON file.
The filename is following `filename(Manga)Infoformat` + .json.
If you want the original info from source, use with `writeRawJSON`.
- writeimageinfo

Set to `True` to export the image information to text file. This is a subset info extracted from the `writeImageJSON`.
Set to `True` to export the compact image information to text file.
The filename is following `filename(Manga)Infoformat` + .txt.
If you want the original info from source, use with `writeRawJSON`.
- writeRawJSON

Set to `True` to export the image JSON untouched.
The filename is following `filename(Manga)Infoformat` + .json.
Set to `True` to export the original JSON untouched of the image for `writeImageJSON`.
- RawJSONFilter

Enter the JSON keys which you want to filter out. Keys are seperated by a comma.
Enter the JSON keys which you want to filter out for `writeRawJSON`. Keys are seperated by a comma.
- includeSeriesJSON

Set to `True` to export the series information to JSON. Non-series artwork doesn't have this info.
Expand Down Expand Up @@ -549,7 +550,7 @@ Please refer run with `--help` for latest information.
Set last modified timestamp based on pixiv upload timestamp to the file.
- useLocalTimezone

Use local timezone when setting last modified timestamp/works date.
Use local timezone in the .txt file of `writeimageinfo` and .XMP file of `writeImageXMP`.
- defaultSketchOption

Skip the "Include Pixiv Sketch" prompt when downloading by `member_id` option by using a default option. Set the value to `y` to always include sketches or `n` to exclude sketches from the download.
Expand Down Expand Up @@ -612,10 +613,20 @@ Please refer run with `--help` for latest information.

Skip downloading if the remote size is not known when `alwaysCheckFileSize` is set to True.

- enablePostProcessing

If true, it enabled post processing cmd for every downloaded files. Default: False.

- postProcessingCmd

command to execute. add %filename% to pass the downloaded filename.
NO ERROR HANDLING AT ALL, use on your own risk.

- extensionFilter

Provide a | seperated list of acceptable file extensions to download. Eg. jpg|png|gif|ugoira


## [FFmpeg]
- ffmpeg

Expand Down Expand Up @@ -662,10 +673,10 @@ Please refer run with `--help` for latest information.
Required `createUgoira = True` and ffmpeg executeable.
- deleteugoira

Set to True to delete original ugoira after conversion.
Set to True to delete the created .ugoira after conversion.
- deleteZipFile

If set to `True`, it will delete the zip files from ugoira.
If set to `True`, it will delete the orignal .zip (i.e. the actual image) file.
Only active if `createUgoira = True`.

## [Filename]
Expand Down

0 comments on commit 32b0e83

Please sign in to comment.