From 9f4dc1cdab2e2a234a6a8e041723bdb7098d7f0c Mon Sep 17 00:00:00 2001 From: Pavel Djundik Date: Fri, 15 May 2020 20:56:00 +0300 Subject: [PATCH] Format readme --- README.md | 75 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 40 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 3235dcd2..e286ff97 100644 --- a/README.md +++ b/README.md @@ -3,41 +3,46 @@ DepotDownloader Steam depot downloader utilizing the SteamKit2 library. Supports .NET Core 2.0 +### Downloading one or all depots for an app +``` +dotnet DepotDownloader.dll -app [-depot [-manifest ]] + [-username [-password ]] [other options] ``` -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. - -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) - -osarch - the architecture for which to download the game (32 or 64, default: the host's architecture) - -all-languages - download all language-specific depots when -app is used. - -language - the language for which to download the game (default: english) - -lowviolence - download low violence depots when -app is used. - - -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). - -loginid <#> - a unique 32-bit integer Steam LogonID in decimal, required if running multiple instances of DepotDownloader concurrently. +### Downloading a workshop item +``` +dotnet DepotDownloader.dll -pubfile [-username [-password ]] +``` +or ``` +dotnet DepotDownloader.dll -ugc [-username [-password ]] +``` + +### Parameters + +Parameter | Description +--------- | ----------- +-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) +-osarch \ | the architecture for which to download the game (32 or 64, default: the host's architecture) +-all-languages | download all language-specific depots when -app is used. +-language \ | the language for which to download the game (default: english) +-lowviolence | download low violence depots when -app is used. +-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). +-loginid \<#> | a unique 32-bit integer Steam LogonID in decimal, required if running multiple instances of DepotDownloader concurrently.