Updated README with cover mention

This commit is contained in:
Felipe M 2021-01-05 19:11:35 +01:00
parent 55b884e17f
commit 0764d40e96
1 changed files with 10 additions and 5 deletions

View File

@ -6,11 +6,11 @@ A simple tool to collect and sort games screenshots from different platforms.
Use the appropriate ID with the `-provider` flag. [See examples below](#Usage)
| Name | ID | Notes |
| --- | --- | --- |
| Steam | `steam` | Linux, macOS, Windows
| Minecraft | `minecraft` | Linux, Linux Flatpak, macOS, Windows
| Nintendo Switch | `nintendo-switch` | Requires `-input-path` |
| Name | ID | Notes | Covers |
| --- | --- | --- | --- |
| Steam | `steam` | Linux, macOS, Windows | Yes [Example](https://steamcdn-a.akamaihd.net/steam/apps/377840/header.jpg) |
| Minecraft | `minecraft` | Linux, Linux Flatpak, macOS, Windows | No |
| Nintendo Switch | `nintendo-switch` | Requires `-input-path` | No |
## How it works
@ -20,6 +20,8 @@ When talking about a game's store (Steam, for example) we need to retrieve a bit
For more details, you can check out [the source code for all providers](https://github.com/fmartingr/games-screenshot-manager/tree/master/pkg/providers)
Optionally a cover image for a game can be downloaded and placed under a `.cover` file in the game path. For this to work use the `-download-cover` flag. Check above for provider support for this feature.
## Installation
```
@ -37,6 +39,9 @@ games-screenshot-manager -h
# Fetch and sort all Steam screenshots into ./Output
games-screenshot-manager -provider steam -output-path ./Output
# Like the one above but it'll download all header images for the games
games-screenshot-manager -provider steam -output-path ./Output -download-covers
# Perform a dry run (see what's gonna get copied where)
games-screenshot-mananger -provider steam -dry-run