Skip to content

TheRealGLH/SteamGridDB-DL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SteamGridDB DL

A CLI tool written in Rust 2021 for automatically downloading the contents of a collection on SteamGridDB into the Steam configuration folder with the appropriate filenames. The code is honestly far from perfect (and whether or not doing it as a Rust project versus just making it a Bash/ Powershell script being the best option is debatable), this project mainly served as a learning experience for me.

Using this tool for dummies

To be written. Will link to its own document.

Installation

If you have Cargo installed, all you need to do is run

cargo install steamgriddb-dl

After which the tool can be run using the following command in your shell:

steamgriddb-dl <id> <options>

Alternatively, the binary can be downloaded from the releases page, after which you can easily run it from the downloaded directory, or after adding it to a folder in your $PATH.

Usage

steamgriddb-dl <id> <options>

Where <id> is the id-number for a collection on SteamGridDB (ie. https://www.steamgriddb.com/collection/[number]). This does not parse the full URL, so only the number will work.

Option Purpose
-n Dry run. Runs the tool as normal— printing all of the files that are to be saved and their directories, but without actually saving them.
--directory=<dir> In some cases the tool cannot find your Steam installation's personal configuration directory, or you may want to save the images in a collection elsewhere. This option lets the user set an override directory.
-h Prints help information.

Build

At the moment, no special actions have to be taken to build the binaries. If you have Cargo installed, you can simply use

cargo build

or for release binaries

cargo build -r

...to build the executable yourself. See also the Rust documentation.

About

A CLI utility for downloading content from www.steamgriddb.com

Topics

Resources

License

Stars

Watchers

Forks