giantbomb-show-dl

2.4.1 • Public • Published

💣 giantbomb-show-dl 💣

npm

Command line tool to download complete Giant Bomb shows or a list of separate videos with a single command.

Requirements

How to

The easiest way to run this tool is to use npx.

npx giantbomb-show-dl@latest --api_key <YOUR_API_KEY> --show "Unprofessional Fridays" --dir "~/Downloads/GiantBomb"

It's also possible to install the tool globally using npm, after which the binary can be used in your shell. If you use this method make sure to regularly check for updates.

npm install -g giantbomb-show-dl

giantbomb-show-dl --api_key <YOUR_API_KEY> --show "Unprofessional Fridays" --dir "~/Downloads/GiantBomb"

Options

Option Required Description
--api_key Your Giant Bomb API key, can be found at https://www.giantbomb.com/api/.
--show 🔀 Name of the Giant Bomb show to download, must be an exact match.
Mutually exclusive with --video_id and --archive.
--video_id 🔀 Giant Bomb video ID, multiple can be separated by commas. IDs can be found in the video URL on the website, they are formatted as 12345-87654.
Mutually exclusive with --show and --archive.
--archive 🔀 Enable archive mode, will download every video from the API one by one.
Mutually exclusive with --show and --video_id.
--dir Directory the videos should be downloaded to. When using the --show option a subdirectory will be created for the selected show.
--quality Quality to download videos in, will fall back to lower quality if selected is not available. Defaults to highest. Options are low, high, hd and highest.
--retries Amount of times a failed download will be retried, defaults to 2.
--from_date Videos published before this date will not be downloaded. Formatted as YYYY-MM-DD. Only when using --show.
--to_date Videos published after this date will not be downloaded. Formatted as YYYY-MM-DD. Only when using --show.
--mp3tag Create a .txt file that can be used within the Mp3tag software to tag your videos for use in media libraries. Ignored when downloading using --archive.
--debug Will output extra logging when enabled, can be useful for troubleshooting.

Features

Highest quality

Will always download the highest quality available for each video. Normally the API does not return 8k bitrate versions of videos. but this tool checks if they are available and downloads them when the quality highest is used.

Download tracking

Will keep track of which files are downloaded successfully. These files will not be downloaded again on the next run, this provides an easy way to retry failed downloads by re-running the same command.

To reset download tracking remove the downloaded.json file from the relative directory.

Download resuming

If a download is interrupted this tool will resume where the download previously ended on the next attempt.

Save images and metadata

This tool also downloads the image(s) and metadata for each show and video. This data can be used to enhance your library in your media server of choice.

Rate limiting

This tool will autmatically rate limit API requests to not exceed Giant Bomb API usage guidelines.

Readme

Keywords

none

Package Sidebar

Install

npm i giantbomb-show-dl

Weekly Downloads

2

Version

2.4.1

License

MIT

Unpacked Size

46.7 kB

Total Files

13

Last publish

Collaborators

  • koenvanzuijlen