diff --git a/README.md b/README.md index edbaa4eb..6d58dc42 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,35 @@ DepotDownloader Steam depot downloader utilizing the SteamKit2 library. Supports .NET Core 2.0 ``` -Usage: ./depotdownloader [optional parameters] -OR: dotnet DepotDownloader.dll [optional parameters] +Usage - downloading one or all depots for an app: + dotnet DepotDownloader.dll -app [-depot [-manifest ] | [-ugc ]] + [-username [-password ]] [other options] + +Usage - downloading a Workshop item published via SteamUGC + dotnet DepotDownloader.dll -pubfile [-username [-password ]] Parameters: - -app <#> - the AppID to download. - -Optional Parameters: - -depot <#> - the DepotID to download. - -cellid <#> - the overridden CellID of the content server to download from. - -username - the username of the account to login to for restricted content. - -password - the password of the account to login to for restricted content. - -remember-password - if set, remember the password for subsequent logins of this user. - -dir - the directory in which to place downloaded files. - -os - the operating system for which to download the game (windows, macos or linux, default: OS the program is currently running on) - -filelist - a list of files to download (from the manifest). - Can optionally use regex to download only certain files. - -all-platforms - downloads all platform-specific depots when -app is used. - -manifest-only - downloads a human readable manifest for any depots that would be downloaded. - -beta - download from specified branch if available (default: Public). - -betapassword - branch password if applicable. - -manifest - manifest id of content to download (requires -depot, default: latest for branch). - -max-servers <#> - maximum number of content servers to use. (default: 8). - -max-downloads <#> - maximum number of chunks to download concurrently. (default: 4). + -app <#> - the AppID to download. + -depot <#> - the DepotID to download. + -manifest - manifest id of content to download (requires -depot, default: current for branch). + -ugc <#> - the UGC ID to download. + -beta - download from specified branch if available (default: Public). + -betapassword - branch password if applicable. + -all-platforms - downloads all platform-specific depots when -app is used. + -os - the operating system for which to download the game (windows, macos or linux, default: OS the program is currently running on) + + -pubfile <#> - the PublishedFileId to download. (Will automatically resolve to UGC id) + + -username - the username of the account to login to for restricted content. + -password - the password of the account to login to for restricted content. + -remember-password - if set, remember the password for subsequent logins of this user. + + -dir - the directory in which to place downloaded files. + -filelist - a list of files to download (from the manifest). Can optionally use regex to download only certain files. + -validate - Include checksum verification of files already downloaded + + -manifest-only - downloads a human readable manifest for any depots that would be downloaded. + -cellid <#> - the overridden CellID of the content server to download from. + -max-servers <#> - maximum number of content servers to use. (default: 8). + -max-downloads <#> - maximum number of chunks to download concurrently. (default: 4). ```