Update README usage info to match usage print output.

pull/49/head
Nicholas Hastings 7 years ago
parent e0afef00e4
commit 2177746a50

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

Loading…
Cancel
Save