fmartingr
/
games-screenshot-manager
mirror of https://github.com/fmartingr/games-screenshot-manager.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated README

This commit is contained in:
Felipe Martin 2023-03-05 20:32:52 +01:00
parent 272ed61d83
commit 0e1ecb5c77
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -8,28 +8,33 @@ 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 | Linux | Windows | macOS | Covers | Notes |
| --------------- | ----------------- | ----- | ------- | ----- | ------ | --------------------------------------------------- |
| Minecraft | `minecraft` | Yes | Yes | Yes | No |
| PlayStation 4 | `playstation-4` | - | - | - | No | Requires `-input-path` pointing to PS4 folder |
| RetroArch | `retroarch` | - | - | - | Yes | Requires `-input-path` pointing to Playlists folder |
| Steam | `steam` | Yes | Yes | Yes | Yes |
| Xbox Game Bar | `xbox-game-bar` | - | - | - | No | Requires `-input-path` pointing to the folder holding the captures |
| Name | ID | Linux | Windows | macOS | Covers | Notes |
| ------------- | --------------- | ----- | ------- | ----- | ------ | ------------------------------------------------------------------ |
| Minecraft | `minecraft` | Yes | Yes | Yes | No |
| PlayStation 4 | `playstation-4` | - | - | - | No | Requires `-input-path` pointing to `PS4` folder |
| PlayStation 5 | `playstation-5` | - | - | - | No | Requires `-input-path` pointing to `PS5` folder |
| RetroArch | `retroarch` | - | - | - | Yes | Requires `-input-path` pointing to Playlists folder |
| Steam | `steam` | Yes | Yes | Yes | Yes |
| Xbox Game Bar | `xbox-game-bar` | - | - | - | No | Requires `-input-path` pointing to the folder holding the captures |
## Requirements
- [exiftool](https://exiftool.org/) to parse EXIF data from files.
- [exiftool](https://exiftool.org/) to parse EXIF data from files. (Using [cozy/goexif2 library](https://github.com/cozy/goexif2))
## How it works
Each provider has it's own way of finding the screenshots, but ideally the screenshots folder for games are known to us users so we only need to traverse them and find image files except for installations that may vary (like Retroarch) or systems outside of the PC ecosystem (Playstation, Nintendo Switch).
Each provider has it's own way of finding the screenshots, but ideally the screenshots folder for games are known to us users so we only need to traverse them and find image files except for installations that may vary (like Retroarch) or systems outside of the PC ecosystem (Playstation).
In some cases to have all the information for a particular provider we need to retrieve more data from the internet, for example the Steam game list to associate names to the IDs or in Nintendo Switch's case a community provided list to associate the internal ID with the Game's name.
In some cases to have all the information for a particular provider we need to retrieve more data from the internet, for example the Steam game list to associate names to the IDs ~~or in Nintendo Switch's case a community provided list to associate the internal ID with the Game's name~~.
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.
## Nintendo Switch notice
This project initially started as a Nintendo Switch helper to import and properly organize screenshots, but Nintendo improved this over the years and now we can use Android File Transfer to easily get the screenshots from a Nintendo Switch with the proper game name as folder name. For more information [read this issue](https://github.com/RenanGreca/Switch-Screenshots/issues/46)
## Installation
```