Updated README with cover mention
This commit is contained in:
parent
55b884e17f
commit
0764d40e96
15
README.md
15
README.md
|
@ -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)
|
Use the appropriate ID with the `-provider` flag. [See examples below](#Usage)
|
||||||
|
|
||||||
| Name | ID | Notes |
|
| Name | ID | Notes | Covers |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| Steam | `steam` | Linux, macOS, Windows
|
| Steam | `steam` | Linux, macOS, Windows | Yes [Example](https://steamcdn-a.akamaihd.net/steam/apps/377840/header.jpg) |
|
||||||
| Minecraft | `minecraft` | Linux, Linux Flatpak, macOS, Windows
|
| Minecraft | `minecraft` | Linux, Linux Flatpak, macOS, Windows | No |
|
||||||
| Nintendo Switch | `nintendo-switch` | Requires `-input-path` |
|
| Nintendo Switch | `nintendo-switch` | Requires `-input-path` | No |
|
||||||
|
|
||||||
## How it works
|
## 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)
|
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
|
## Installation
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -37,6 +39,9 @@ games-screenshot-manager -h
|
||||||
# Fetch and sort all Steam screenshots into ./Output
|
# Fetch and sort all Steam screenshots into ./Output
|
||||||
games-screenshot-manager -provider steam -output-path ./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)
|
# Perform a dry run (see what's gonna get copied where)
|
||||||
games-screenshot-mananger -provider steam -dry-run
|
games-screenshot-mananger -provider steam -dry-run
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue