humbleclient 0.1.3

Quickstart

Simply put your login information into the configuration file (see Configuration) and run humblec download to get all your DRM-free games. You can also use humblec --key KEY download to get the games of a bundle without using an account.

See Usage for more details.

Listing orders

$ humblec list-bundles

Options:

• --content: display the content of each bundle,

• --files : display the individual files associated to each game.

Listing games

$ humblec list-games

Options:

• --files: display the individual files associated to each game.

This command is slower than the previous one since it requires to download the complete games list before displaying it in order to display once games which have been purchased multiple times.

Downloading games

$ humblec download

Only the files which are not filtered out by the filters (see Filtering) will be downloaded.

To precisely select what to download or to override the filters given in the configuration file, the following command line flags are available:

• --bundles BUNDLE [BUNDLE ...]: download only the given bundles,

• --games GAME [GAME ...]: download only the given games,

• --platforms PLATFORM [PLATFORM ...]: download only files for the given platforms,

• --files FILE [FILE ...]: download only files corresponding to the given codenames.

Be careful that other filters are still applied: for example, if you select a particular file with --files but the platform of this file is filtered out, nothing will be downloaded, you also need to override the platform with --platforms.

Other options:

• --directory DIRECTORY or -d DIRECTORY: download files to this directory instead of the one in the configuration file,

• --dry-run or -n: do not download anything, just display download commands.

Example

The default values are the following:

account:
  email:
  password:

keys: []

directory: ~/Humble

exclude:
  bundles: []
  # bundles:
  #   - hib8 # I do not like games from the Humble Indie Bundle 8
  platforms: []
  # platforms:
  #   - mac # I do not have a mac
  games: []
  files: []

format:
  download: "{game_name}/{filename}"
  file:     "- {title} ({platform}, {human_size}, {name}, {filename})"
  game:     "- {title} ({name}, {url})"
  order:    "* {title} ({name}, {url})"

Filtering

There are 4 filters available:

• bundles

• platforms

• games

• files

Each filter expects a list of code names which can be found using list-orders or list-games.

Formatting

Output format can be customized using the format section of the configuration file. There are 4 different format string, which accept different variables:

• order

  • key: Key of the bundle

  • title: Title of the bundle

  • name: Code name of the bundle

  • url: URL of the bundle

• game

  • name: Code name of the game

  • title: Human name of the game

  • icon: URL of an icon

  • url: URL of the game

  • editor: Editor of the game

• file and download

  • game_name: Code name of the game

  • game_title: Human name of the game

  • game_editor: Human name of the editor

  • platform: Platform

  • name: Code name of the file

  • title: Human name of the download (often not really interesting, like “Download”)

  • size: Size of the file

  • human_size: Human size of the file

  • sha1: SHA1 hash of the file (if available)

  • md5: MD5 hash of the file (if available)

  • url: Download url

  • torrent: Torrent url (if available)

  • filename: Filename