Go to file
Felipe Martin Garcia af72c45833 feat: cache support (#19)
- Added file and memory cache handlers
- Steam provider now uses a cache to store the app list for 24h

Closes #12
2022-01-30 19:26:29 +01:00
.github Added goreleaser configuration 2021-05-16 20:10:42 +02:00
cmd/games-screenshot-manager Created internal/cmd folders 2021-05-08 11:37:52 +02:00
internal feat: cache support (#19) 2022-01-30 19:26:29 +01:00
pkg feat: cache support (#19) 2022-01-30 19:26:29 +01:00
.gitignore refactor: working on new version 2022-01-30 19:26:29 +01:00
.goreleaser.yml Added goreleaser configuration 2021-05-16 20:10:42 +02:00
Makefile Created internal/cmd folders 2021-05-08 11:37:52 +02:00
README.md Updated README 2021-05-16 20:13:32 +02:00
go.mod feat: improved logging with logrus 2022-01-30 19:26:29 +01:00
go.sum feat: improved logging with logrus 2022-01-30 19:26:29 +01:00

README.md

Games Screenshot Manager

Go Report Card

A simple tool to collect and sort games screenshots from different platforms.

Supported providers

Use the appropriate ID with the -provider flag. See examples below

Name ID Linux Windows macOS Covers Notes
Steam steam Yes Yes Yes Yes
Minecraft minecraft Yes Yes Yes No
Nintendo Switch nintendo-switch - - - No Requires -input-path pointing to ALBUM folder
PlayStation 4 playstation-4 - - - No Requires -input-path pointing to PS4 folder
RetroArch retroarch - - - Yes Requires -input-path pointing to Playlists folder

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).

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

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

go get -u github.com/fmartingr/games-screenshot-manager

Or get the latest binary build from the releases page

Usage

# Help
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-manager -provider steam -dry-run

# Parse all Nintendo Switch screenshots
games-screenshot-manager -provider nintendo-switch -input-path ./Album