Skip to content

Latest commit

 

History

History
98 lines (71 loc) · 3.08 KB

README.md

File metadata and controls

98 lines (71 loc) · 3.08 KB
Raw

KhInsider Downloder

Main Build Deploy

This is a small, but lightning fast, utility command line application that aids with downloading soundtracks from khinsider. The purpose of this application is to expedite the download process by downloading the album in the desired format.

Getting Started

Follow the instructions below to get the app running.

Installing the App

  • Download NodeJS
  • Run npm install in the project directory.

Running the App

There are two ways to run the app – with ts-node directly invoking the index.ts file, or you can use the npm start command, and pass the expected arguments there.

Available Arguments

Options:
      --help       Show help                                           [boolean]
      --version    Show version number                                 [boolean]
  -a, --album      The album to download.                    [string] [required]
  -o, --outdir     The name of the folder to produce.        [string] [required]
  -f, --format     Which format do you want to download?
                              [string] [choices: "flac", "mp3"] [default: "mp3"]
  -l, --log-level  What level of logging verbosity do you want?
                   [string] [choices: "info", "warn", "error"] [default: "info"]

Using npm start

npm start -- --album="{album here}" --outdir="~/Downloads"

Using ts-node

npx ts-node ./src/index.ts --album="{album here}" --outdir="~/Downloads"

Album Argument Explained

The --album argument should be the name of the album that is the last part of the khinsider URL. An example follows below.

Given the following URL: https://downloads.khinsider.com/game-soundtracks/album/legend-of-zelda-the-ocarina-of-time-1998-n64 you will want to take the legend-of-zelda-the-ocarina-of-time-1998-n64 portion of the URL. This is what must be supplied to the --album argument.

How the Output is Generated

Given the album name, the --outdir argument will be where the download is output. For example, given legend-of-zelda-the-ocarina-of-time-1998-n64 as the album name, then a folder will be created in the supplied directory with the given album name. All songs that are downloaded will be written to that named folder.

Publishing Binaries

To publish the binaries so that others can run them without having to clone the repository, you can use the bundle script by calling it as npm run bundle. The output will be generated to the bin directory.

The output is published for the following platforms:

  • Windows (x64)
  • MacOS (x64)
  • Linux (x64)

Consuming as Build Artifacts

Currently, the build pipeline creates artifacts for each build. The binaries can be pulled as artifacts from the build history.

Issues

If you encounter any issues during use, please enter an issue in the issue tracker. Pull requests are greatly appreciated.