Skip to content

README.md

Latest commit

 

History

History
40 lines (27 loc) · 1.63 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.63 KB
Raw

steamer

A CLI-tool to automatically fetch and download SteamGridDB assets for your non-steam games.
Downloads missing icon, grid, hero and logo for each game. Will preserve existing assets by default but can be overridden by the --overwrite flag.

Tested on linux, other platforms untested but should work.

Installation

You can download the latest release of the tool directly from github.

Alternatively you can install it via cargo, the Rust package manager:

cargo install --git https://github.com/kaezrr/steamer.git

Usage

You will need a SteamGridDB API key in order to use this tool, you can get it by creating an account on SteamGridDB and then going to preferences > api

Usage: steamer [OPTIONS] --api-key <API_KEY>

Options:
      --api-key <API_KEY>  Your SteamGridDB API key
  -i, --interactive        Interactively choose which SteamGridDB game to pick
  -o, --overwrite          Overwrite all existing assets and refetch them
  -h, --help               Print help

By default it always picks the first match for icons, heroes, grids and logos.

Possible Improvements

  • Extend it to work on normal steam games
  • Add the option to preserve existing steamgrid assets instead of always overwriting
  • Add configuration file to save api key and other configuration options for covers, heroes, etc
  • Integrate OS file events and add a --watch so that it runs automatically in the background efficiently
  • Possible further parallelization improvements to make it work even faster