diff --git a/README.md b/README.md new file mode 100644 index 0000000..3759e47 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +Sync your steam screenshots to [Immich](https://immich.app/). + +# Synopsis + +``` +Usage: steam-immich --base-url BASE_URL --api-key API_KEY [--steam-userdata-dir USERDATA_DIR] [--device-id DEVICE-ID] [--album ALBUM] [--cache CACHE] [--revalidate] [--verbose] + +Options: + --base-url BASE_URL Base URL of the Immich instance e.g.: https://demo.immich.app + --api-key API_KEY API Key. Needs asset.upload, asset.update, albumAsset.create + --steam-userdata-dir USERDATA_DIR + Steam userdata directory. If not set, search automaticly. + --device-id DEVICE-ID + Device ID of the uploads [default: steam-immich] + --album ALBUM UUID of a album to upload to + --cache CACHE Location of the cache file [default: $XDG_CACHE_HOME/steam-immich.json] + --revalidate Only revalidate and fix the cache + --verbose, -v Toggle verbose logging + --help, -h display this help and exit +``` + +# Usage + +Running the command tries to find the Steam screenshots directory and uploads any screenshots to Immich. +The game name will be put in the description of the image. + +Optionally, you can specify an album in which the screenshots should be added. + +Running the command again will only upload new screenshots since it saves the state locally. + +You could automate uploading with a cron job or somehow run it at Steam startup. But thats outside the scope of this software.