DepotDownloader

https://github.com/steamre/depotdownloader
Admin
DepotDownloader is a command-line utility utilizing the SteamKit2 library to download steam depots,...
Tokens:37,019
Snippets:296
Trust Score:7.9
License:GPL-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example: Platform-aware default filters used at startup

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Gets the OS and architecture strings for use as default depot filters. Comments show possible return values.

```csharp
// Platform-aware default filters used at startup
var os = Util.GetSteamOS();      // "windows" | "macos" | "linux" | "unknown"
var arch = Util.GetSteamArch();  // "64" | "32"
```

--------------------------------

### Programmatic configuration example

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DownloadConfig.md

Shows how to configure a download programmatically before calling InitializeSteam3. Sets install directory, verification, concurrency, CellID, and file filtering with exact paths and regex patterns.

```csharp
// Programmatically configure a download before InitializeSteam3
ContentDownloader.Config.InstallDirectory = "/data/steam/730";
ContentDownloader.Config.VerifyAll = true;
ContentDownloader.Config.MaxDownloads = 16;
ContentDownloader.Config.CellID = 1234;
ContentDownloader.Config.UsingFileList = true;
ContentDownloader.Config.FilesToDownload = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
    "bin/client.dll"
};
ContentDownloader.Config.FilesToDownloadRegex =
    [new Regex(@"^cfg/.*\.cfg$", RegexOptions.Compiled | RegexOptions.IgnoreCase)];
```

--------------------------------

### Example: Download manifest with CDNClientPool

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Shows typical usage: create a pool, update the server list, get a connection, download a manifest, and return the connection. On a Forbidden status, requests a CDN auth token and returns the connection for retry.

```csharp
var pool = new CDNClientPool(session, 730);
await pool.UpdateServerList();

Server conn = pool.GetConnection();
try
{
    var manifest = await pool.CDNClient.DownloadManifestAsync(
        depotId, manifestId, manifestRequestCode,
        conn, depotKey, pool.ProxyServer, cdnToken);
    pool.ReturnConnection(conn);
}
catch (SteamKitWebRequestException e) when (e.StatusCode == HttpStatusCode.Forbidden)
{
    await session.RequestCDNAuthToken(730, depotId, conn);
    pool.ReturnConnection(conn);   // retry after acquiring the CDN token
}
```

--------------------------------

### Program Startup Guard

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/PlatformUtilities.md

Example of using VerifyConsoleLaunch during program startup on Windows when no arguments are provided.

```csharp
// Program startup guard (Windows only, no args)
if (OperatingSystem.IsWindowsVersionAtLeast(5, 0))
{
    PlatformUtilities.VerifyConsoleLaunch();
}
```

--------------------------------

### Example usage of Ansi

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Shows typical usage: call Init once at startup, then use Progress with Indeterminate state, with a percentage during download, and Hidden on completion. All calls are no-ops when progress is not usable.

```csharp
Ansi.Init();                                  // detect capability once at startup
Ansi.Progress(Ansi.ProgressState.Indeterminate);
// ... during download, per chunk:
Ansi.Progress(totalBytesUncompressed, completeDownloadSize);  // percent bar
// ... on completion:
Ansi.Progress(Ansi.ProgressState.Hidden);
```

--------------------------------

### Legacy manifest migration example

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Shows the migration path exercised by Util.LoadManifestFromFile: loads a legacy manifest, converts it to a Steam manifest, and saves it.

```csharp
// Legacy manifest migration path exercised by Util.LoadManifestFromFile
if (File.Exists(binPath))
{
    var oldManifest = ProtoManifest.LoadFromFile(binPath, out var checksum);
    if (oldManifest != null)
    {
        var steamManifest = oldManifest.ConvertToSteamManifest(depotId);
        Util.SaveManifestToFile(configDir, steamManifest);
    }
}
```

--------------------------------

### Install via winget

Source: https://github.com/steamre/depotdownloader/blob/master/README.md

Install the latest Terminal release of DepotDownloader on Windows using the winget package manager.

```powershell
winget install --exact --id SteamRE.DepotDownloader
```

--------------------------------

### Example usage of HttpClientFactory.CreateHttpClient

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Networking.md

Shows how to create an HttpClient and download a stream. The client is configured with a default User-Agent header and is used for direct web-file downloads.

```csharp
using var client = HttpClientFactory.CreateHttpClient();
var stream = await client.GetStreamAsync("https://.../file.bin");
await stream.CopyToAsync(output);
```

--------------------------------

### Example: Reuse on-disk manifest for delta downloading

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Loads a manifest from disk and saves it back if valid, caching it. If null, the manifest must be fetched from the CDN.

```csharp
// Reuse an on-disk manifest for delta downloading
var manifest = Util.LoadManifestFromFile(configDir, 731, 7617088375292372759UL, badHashWarning: true);
if (manifest == null)
{
    // need to fetch from CDN
}
else if (Util.SaveManifestToFile(configDir, manifest))
{
    Console.WriteLine("Manifest cached.");
}
```

--------------------------------

### Install via Homebrew

Source: https://github.com/steamre/depotdownloader/blob/master/README.md

Install the latest release of DepotDownloader on macOS using Homebrew.

```shell
brew tap steamre/tools
brew install depotdownloader
```

--------------------------------

### Apply Executable Bits from Manifest

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/PlatformUtilities.md

Example of using SetExecutable to apply manifest flags to a file after download.

```csharp
// Apply executable bits from manifest flags
if (file.Flags.HasFlag(EDepotFileFlag.Executable))
{
    PlatformUtilities.SetExecutable(fileFinalPath, true);
}
else
{
    PlatformUtilities.SetExecutable(fileFinalPath, false);
}
```

--------------------------------

### Example: Validate existing file before deciding which chunks to fetch

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Opens a file, adjusts its length to the expected total size, and validates checksums to determine which chunks are still needed. Prints the count of needed chunks.

```csharp
// Validate an existing file before deciding which chunks to fetch
using var fs = File.Open(finalPath, FileMode.Open);
if ((ulong)fs.Length != file.TotalSize)
{
    fs.SetLength((long)file.TotalSize);
}
var neededChunks = Util.ValidateSteam3FileChecksums(fs, file.Chunks.OrderBy(c => c.Offset).ToArray());
Console.WriteLine("Need {0} chunks for {1}", neededChunks.Count, file.FileName);
```

--------------------------------

### Example: Handle broken connection with ReturnBrokenConnection

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Shows how to handle a permanently broken connection: on any exception, call ReturnBrokenConnection to advance the round-robin cursor so subsequent GetConnection calls skip the broken server.

```csharp
// Handling a permanently broken connection
try
{
    written = await pool.CDNClient.DownloadDepotChunkAsync(
        depot.DepotId, chunk, conn, buffer, depot.DepotKey, pool.ProxyServer, cdnToken);
    pool.ReturnConnection(conn);
}
catch
{
    pool.ReturnBrokenConnection(conn); // advances the round-robin cursor
}
```

--------------------------------

### Orchestrate a full app download with an existing Steam3 session

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

Initializes Steam3 with credentials, downloads an app (e.g., app 730) using a depot list with an invalid manifest ID to fetch the latest, and handles ContentDownloaderException. Finally shuts down Steam3. The example shows a typical try-catch-finally pattern.

```csharp
// Orchestrate a full app download with an existing Steam3 session
if (ContentDownloader.InitializeSteam3("user", "pass"))
{
    try
    {
        var depots = new List<(uint depotId, ulong manifestId)>
        {
            (730, ContentDownloader.INVALID_MANIFEST_ID)
        };
        await ContentDownloader.DownloadAppAsync(
            730, depots, ContentDownloader.DEFAULT_BRANCH,
            null, null, null, lv: false, isUgc: false);
    }
    catch (ContentDownloaderException ex)
    {
        Console.WriteLine(ex.Message); // e.g. "App 730 (Counter-Strike: GO) is not available from this account."
    }
    finally
    {
        ContentDownloader.ShutdownSteam3();
    }
}
```

--------------------------------

### QR-code login configuration example

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DownloadConfig.md

Configures QR-code authentication, which is mutually exclusive with using a username. Enables QR code login and optionally persists the refresh token, while skipping the mobile app confirmation prompt.

```csharp
// QR-code login configuration (mutually exclusive with -username)
ContentDownloader.Config.UseQrCode = true;
ContentDownloader.Config.RememberPassword = true;   // persist the refresh token
ContentDownloader.Config.SkipAppConfirmation = false;
```

--------------------------------

### Login with remembered token, branch, and validation

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Program.md

Logs in with a remembered password token, selects the beta branch with a branch password, sets the output directory, and validates files. exitCode equals 1 if any validation failure occurs, for example when -branchpassword is used without -branch.

```csharp
var exitCode = await Program.Main(new[]
{
    "-app", "730",
    "-username", "myaccount",
    "-remember-password",
    "-branch", "beta",
    "-branchpassword", "secret",
    "-dir", "/data/steam/730",
    "-validate"
});
```

--------------------------------

### DepotConfigStore protobuf contract

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/types.md

Defines the DepotConfigStore protobuf contract with a single field InstalledManifestIDs (ProtoMember 1) mapping DepotID to installed ManifestGID. Consumed by ContentDownloader.ProcessDepotManifestAndFiles and DownloadSteam3AsyncDepotFiles.

```csharp
[ProtoContract]
class DepotConfigStore
{
    [ProtoMember(1)] public Dictionary<uint, ulong> InstalledManifestIDs { get; private set; }
}
```

--------------------------------

### Example — -no-mobile behavior

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ConsoleAuthenticator.md

Demonstrates the -no-mobile behavior: setting SkipAppConfirmation to true causes AcceptDeviceConfirmationAsync to return false, so SteamKit2 will request a typed device/email code instead.

```csharp
// -no-mobile sets this flag in Program.Main
ContentDownloader.Config.SkipAppConfirmation = true;

var authenticator = new ConsoleAuthenticator();
bool accept = await authenticator.AcceptDeviceConfirmationAsync();
// false: SteamKit2 will instead request a typed device/email code via
// GetDeviceCodeAsync / GetEmailCodeAsync, so the user enters a 2FA code manually.
```

--------------------------------

### InitializeSteam3

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

Initializes a Steam3 session using the provided username and password. Resolves a stored login token if the username is not null and Config.RememberPassword is true. Blocks until credentials are obtained, returning false if login fails, otherwise starts the background callback pump and returns true.

```APIDOC
## InitializeSteam3

### Description
Initializes a Steam3 session using the provided username and password. Resolves a stored login token if the username is not null and Config.RememberPassword is true. Blocks until credentials are obtained, returning false if login fails, otherwise starts the background callback pump and returns true.

### Method
`public static bool InitializeSteam3(string username, string password)`

### Parameters
- **username** (string) - Required - The Steam username.
- **password** (string) - Required - The Steam password.

### Returns
- **bool** - `true` if login succeeded; `false` otherwise.

### Remarks
- The effective `LoginID` is `Config.LoginID ?? 0x534B32` (`"SK2"`).
- If login never succeeds, prints `Unable to get steam3 credentials.` and returns `false`.
- On success, starts the background callback pump via `Task.Run(steam3.TickCallbacks)`.
```

--------------------------------

### Example — device code retry

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ConsoleAuthenticator.md

Shows calling GetDeviceCodeAsync with previousCodeWasIncorrect set to true. It prints an error message and prompts until a non-empty code is entered; returns null on EOF.

```csharp
var code = await new ConsoleAuthenticator().GetDeviceCodeAsync(previousCodeWasIncorrect: true);
// prints: The previous 2-factor auth code you have provided is incorrect.
// then prompts until a non-empty code is entered; null on EOF
```

--------------------------------

### BeginAuthSessionViaCredentialsAsync with ConsoleAuthenticator

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ConsoleAuthenticator.md

Shows how ConsoleAuthenticator is passed inside AuthSessionDetails when starting an auth session via credentials. This is used in Steam3Session.ConnectedCallback for credential-based authentication.

```csharp
var authSession = await steamClient.Authentication.BeginAuthSessionViaCredentialsAsync(
    new AuthSessionDetails
    {
        Username = username,
        Password = password,
        IsPersistentSession = ContentDownloader.Config.RememberPassword,
        GuardData = guarddata,
        Authenticator = new ConsoleAuthenticator(),
    });
```

--------------------------------

### Main method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Program.md

Entry point of the application. Parses command-line arguments, validates them, and dispatches to one of three download modes. Returns 0 on success or when invoked with no arguments or -V/--version, and 1 for every validated usage error or download failure.

```csharp
static async Task<int> Main(string[] args)
```

--------------------------------

### Main

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Program.md

The entry point of the application. Parses command-line arguments, validates them, and dispatches to the appropriate download mode. Returns the process exit code.

```APIDOC
## Main

### Description
Process entry point that parses command-line arguments, validates them, and dispatches to one of three download modes. Returns the process exit code.

### Method
Main

### Signature
```csharp
static async Task<int> Main(string[] args)
```

### Parameters
- **args** (string[]) - Required - Raw command-line arguments.

### Returns
- **Task<int>** - Exit code: 0 on success or when invoked with no arguments / -V / --version, 1 for validated usage errors or download failures.

### Behavior by Invocation
| Invocation | Behavior |
|------------|----------|
| `args.Length == 0` | Prints version + usage, calls `PlatformUtilities.VerifyConsoleLaunch()` on Windows (≥ 5.0), returns `0` |
| `-V` or `--version` (single arg) | Prints version + runtime, returns `0` |
| `-debug` present | Prints version, enables `DebugLog`, attaches `HttpDiagnosticEventListener` |
| `-pubfile <id>` present | `DownloadPubfileAsync` mode |
| `-ugc <id>` present | `DownloadUGCAsync` mode |
| otherwise | App/depot download mode (`DownloadAppAsync`) |

### Validation Failures
Each prints the message and returns `1`.

| Condition | Message |
|-----------|---------|
| `-remember-password` without `-username`/`-qr` | `Error: -remember-password can not be used without -username or -qr.` |
| `-qr` with `-username` | `Error: -qr can not be used with -username.` |
| no `-app` | `Error: -app not specified!` |
| `-branchpassword` without `-branch` | `Error: Cannot specify -branchpassword when -branch is not specified.` |
| `-os` with `-all-platforms` | `Error: Cannot specify -os when -all-platforms is specified.` |
| `-osarch` with `-all-archs` | `Error: Cannot specify -osarch when -all-archs is specified.` |
| `-language` with `-all-languages` | `Error: Cannot specify -language when -all-languages is specified.` |
| `-manifest` count ≠ `-depot` count | `Error: -manifest requires one id for every -depot specified` |
| `InitializeSteam` returns false | `Error: InitializeSteam failed` |

### Download Failure Handling
Download bodies catch `ContentDownloaderException` and `OperationCanceledException`, print `ex.Message`, and return `1`. Any other exception is printed as `Download failed to due to an unhandled exception: {0}` and re-thrown.

### Dispatch Calls
```csharp
await ContentDownloader.DownloadPubfileAsync(appId, pubFile).ConfigureAwait(false);
await ContentDownloader.DownloadUGCAsync(appId, ugcId).ConfigureAwait(false);
await ContentDownloader.DownloadAppAsync(appId, depotManifestIds, branch, os, arch, language, lv, isUGC)
    .ConfigureAwait(false);
```

Each mode wraps the call in `try / catch / finally { ContentDownloader.ShutdownSteam3(); }`.
```

--------------------------------

### UpdateServerList method

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Fetches servers via steamSession.steamContent.GetServersForSteamPipe(). Sets ProxyServer to the first server with UseAsProxy. Builds servers from eligible servers for appId (AllowedAppIds empty or contains appId) and type "SteamCache" or "CDN", ordered by ContentServerPenalty then WeightedLoad, adding each server NumEntries times. Throws Exception("Failed to retrieve any download servers.") when no eligible servers exist.

```csharp
public async Task UpdateServerList()
```

--------------------------------

### Unix Executable Bit Modification

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/PlatformUtilities.md

Example demonstrating how SetExecutable preserves existing file modes while modifying execute bits on Unix.

```csharp
// Unix usage detail: mode is read before modification, so unrelated bits are
// preserved; value:true ORs in the execute bits, value:false strips them.
PlatformUtilities.SetExecutable("/data/steam/bin/server", true);
if ((File.GetUnixFileMode("/data/steam/bin/server") & UnixFileMode.UserExecute) != 0)
{
    Console.WriteLine("executable bit set");
}
```

--------------------------------

### AccountSettingsStore.Instance

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/AccountSettingsStore.md

The singleton instance of AccountSettingsStore. Only valid after LoadFromFile succeeds.

```APIDOC
## AccountSettingsStore.Instance

### Description
The singleton instance of AccountSettingsStore. Only valid after LoadFromFile succeeds.

### Type
public static AccountSettingsStore Instance

### Remarks
- Must be loaded via LoadFromFile before use.
```

--------------------------------

### InstalledManifestIDs property declaration

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DepotConfigStore.md

Declares the dictionary that maps depot IDs to the last successfully installed manifest GID. Marked with [ProtoMember(1)] for protobuf-net serialization.

```csharp
[ProtoMember(1)]
public Dictionary<uint, ulong> InstalledManifestIDs { get; private set; }
```

--------------------------------

### LoadFromFile method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DepotConfigStore.md

Loads the store from the given file. Throws Exception("Config already loaded") if called twice. If the file exists, it is decompressed and deserialized; otherwise a new empty instance is created.

```csharp
public static void LoadFromFile(string filename)
```

--------------------------------

### AccountSettingsStore.LoadFromFile(string filename)

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/AccountSettingsStore.md

Loads the account settings from the specified file in isolated storage. Throws an exception if already loaded. If the file exists, it is decompressed and deserialized; on IOException, a fresh instance is created. Otherwise, a new empty instance is created.

```APIDOC
## AccountSettingsStore.LoadFromFile(string filename)

### Description
Loads the account settings from the specified file in isolated storage. Throws an exception if already loaded. If the file exists, it is decompressed and deserialized; on IOException, a fresh instance is created. Otherwise, a new empty instance is created.

### Method
LoadFromFile

### Signature
public static void LoadFromFile(string filename)

### Parameters
- **filename** (string) - Required - The name of the file to load from.

### Exceptions
- **Exception** - Thrown if the config has already been loaded.

### Remarks
- The instance FileName is set to the provided filename.
- On IOException during load, a fresh instance is created with a message.
```

--------------------------------

### LoadManifestFromFile method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Attempts to load the Steam-format manifest <directory>/<depotId>_<manifestId>.manifest, verifying it against the sidecar <...>.sha file; on mismatch prints 'Manifest {0} on disk did not match the expected checksum.' when badHashWarning. If no valid Steam manifest exists, falls back to the legacy <depotId>_<manifestId>.bin via ProtoManifest.LoadFromFile and converts it with ConvertToSteamManifest(depotId). Returns null when no usable manifest is found.

```csharp
public static DepotManifest LoadManifestFromFile(
    string directory, uint depotId, ulong manifestId, bool badHashWarning)
```

--------------------------------

### Download Workshop item by published file ID with session token

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

Sets RememberPassword and InstallDirectory configuration, initializes Steam3 with a null password to reuse the saved token, downloads a Workshop item by published file ID (e.g., 1885082371), and handles OperationCanceledException. Finally shuts down Steam3.

```csharp
// Workshop item by published file id, remembering the session token
ContentDownloader.Config.RememberPassword = true;
ContentDownloader.Config.InstallDirectory = "/data/steam";

if (ContentDownloader.InitializeSteam3("user", password: null))
{
    try
    {
        await ContentDownloader.DownloadPubfileAsync(730, 1885082371);
    }
    catch (OperationCanceledException)
    {
        Console.WriteLine("Download cancelled.");
    }
    finally
    {
        ContentDownloader.ShutdownSteam3();
    }
}
```

--------------------------------

### DownloadConfig class definition

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/types.md

Configuration contract for a download operation. All properties are public settable values controlling cell ID, platform/arch/language filters, manifest-only mode, install directory, file-list filtering, beta password, and verification.

```csharp
class DownloadConfig
{
    public int CellID { get; set; }
    public bool DownloadAllPlatforms { get; set; }
    public bool DownloadAllArchs { get; set; }
    public bool DownloadAllLanguages { get; set; }
    public bool DownloadManifestOnly { get; set; }
    public string InstallDirectory { get; set; }
    public bool UsingFileList { get; set; }
    public HashSet<string> FilesToDownload { get; set; }
    public List<Regex> FilesToDownloadRegex { get; set; }
    public string BetaPassword { get; set; }
    public bool VerifyAll { get; set; }
    public int CellID { get; set; }
}
```

--------------------------------

### AccountSettingsStore.Save()

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/AccountSettingsStore.md

Serializes the current instance (deflate-compressed) to the isolated-storage file. Throws an exception if not loaded. IOException is caught and logged.

```APIDOC
## AccountSettingsStore.Save()

### Description
Serializes the current instance (deflate-compressed) to the isolated-storage file. Throws an exception if not loaded. IOException is caught and logged.

### Method
Save

### Signature
public static void Save()

### Exceptions
- **Exception** - Thrown if the config has not been loaded yet.

### Remarks
- The instance is serialized to the isolated-storage file.
```

--------------------------------

### ProtoManifest.LoadFromFile

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Loads a legacy manifest from a file. Returns null if the file does not exist. Decompresses the deflate stream, computes the SHA-1 checksum, and deserializes the ProtoManifest.

```APIDOC
## LoadFromFile

### Description
Loads a legacy manifest from a file. Returns null if the file does not exist. Decompresses the deflate stream, computes the SHA-1 checksum, and deserializes the ProtoManifest.

### Method
Static method

### Signature
```csharp
public static ProtoManifest LoadFromFile(string filename, out byte[] checksum)
```

### Parameters
- **filename** (string) - Required - The path to the legacy manifest file.
- **checksum** (out byte[]) - Required - Output parameter that receives the SHA-1 checksum of the serialized bytes.

### Returns
- **ProtoManifest** - The deserialized manifest, or null if the file does not exist.

### Remarks
- If the file does not exist, returns null and sets checksum to null.
- Decompresses the deflate stream before deserialization.
- Computes checksum as SHA1.HashData of the decompressed bytes.
```

--------------------------------

### Ansi.Progress(ulong downloaded, ulong total)

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Computes a percentage from downloaded and total byte counts and emits a default progress bar with that percentage. Uses ProgressState.Default.

```APIDOC
## Ansi.Progress(ulong downloaded, ulong total)

### Description
Computes a percentage byte from `downloaded / total` (rounded to an integer percent, clamped to a byte) and calls the second overload with `ProgressState.Default`. Emits the progress escape sequence when ANSI progress is enabled.

### Method
Static method

### Signature
```csharp
public static void Progress(ulong downloaded, ulong total)
```

### Parameters
- **downloaded** (ulong) - Required - The number of bytes downloaded so far.
- **total** (ulong) - Required - The total number of bytes to download.

### Behavior
Computes a percentage byte from `downloaded / total` (rounded to an integer percent, clamped to a byte) and calls the second overload with `ProgressState.Default`. Emits the escape sequence only when `useProgress` is true.
```

--------------------------------

### Init method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Initializes ANSI support detection. No-ops when stdin or stdout is redirected, or on Linux. Otherwise runs AnsiDetector.Detect and enables useProgress only when ANSI is supported and the console is not legacy.

```csharp
public static void Init()
```

--------------------------------

### Construct Steam3Session and Request Depot Info

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Steam3Session.md

Creates a Steam3Session with user credentials, waits for credentials, then requests app info, depot key, and manifest request code. Handles the case where anonymous accounts may be refused old manifests by checking if the code is zero.

```csharp
// Construct a session (this also starts the connection attempt)
var session = new Steam3Session(new SteamUser.LogOnDetails
{
    Username = "user",
    Password = "pass",
    ShouldRememberPassword = true,
    LoginID = 0x534B32,
});

// Block until credentials are ready
if (session.WaitForCredentials())
{
    _ = Task.Run(session.TickCallbacks);

    await session.RequestAppInfo(730);
    await session.RequestDepotKey(731, 730);

    var code = await session.GetDepotManifestRequestCodeAsync(731, 730, 7617088375292372759UL, "public");
    if (code == 0)
    {
        // anonymous accounts may be refused old manifests
        Console.WriteLine("No manifest request code returned.");
    }

    session.Disconnect();
}
```

--------------------------------

### Save method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DepotConfigStore.md

Serializes the Instance to the configured file path with deflate compression. Throws Exception("Saved config before loading") if called before LoadFromFile. No try/catch; IOException propagates to the caller.

```csharp
public static void Save()
```

--------------------------------

### Download workshop item using pubfile id

Source: https://github.com/steamre/depotdownloader/blob/master/README.md

Download a workshop item by specifying the app ID and the pubfile ID.

```powershell
./DepotDownloader -app <id> -pubfile <id> [-username <username> [-password <password>]]
```

```powershell
./DepotDownloader -app 730 -pubfile 1885082371
```

--------------------------------

### Singleton instance declaration

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DepotConfigStore.md

Static singleton instance of DepotConfigStore. Valid only after LoadFromFile is called.

```csharp
public static DepotConfigStore Instance;
```

--------------------------------

### AccountSettingsStore Singleton Instance

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/AccountSettingsStore.md

Static field holding the singleton instance. Only valid after LoadFromFile succeeds.

```csharp
public static AccountSettingsStore Instance;
```

--------------------------------

### AccountSettingsStore Fields and Properties

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/AccountSettingsStore.md

Declares the protobuf-net serialized properties: ContentServerPenalty (CDN host to penalty weight), LoginTokens (username to refresh token), and GuardData (username to guard data). Proto members 1 and 3 are retired legacy fields.

```csharp
[ProtoMember(2, IsRequired = false)]
public ConcurrentDictionary<string, int> ContentServerPenalty { get; private set; }

// Member 3 was a Dictionary<string, string> for LoginKeys.

[ProtoMember(4, IsRequired = false)]
public Dictionary<string, string> LoginTokens { get; private set; }

[ProtoMember(5, IsRequired = false)]
public Dictionary<string, string> GuardData { get; private set; }
```

--------------------------------

### AccountSettingsStore ProtoContract class

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/types.md

ProtoContract class with ProtoMember attributes for persisted account settings. Fields: ContentServerPenalty (CDN host → penalty), LoginTokens, and GuardData.

```csharp
[ProtoContract]
class AccountSettingsStore
{
    [ProtoMember(2, IsRequired = false)] public ConcurrentDictionary<string, int> ContentServerPenalty { get; private set; }
    [ProtoMember(4, IsRequired = false)] public Dictionary<string, string> LoginTokens { get; private set; }
    [ProtoMember(5, IsRequired = false)] public Dictionary<string, string> GuardData { get; private set; }
}
```

--------------------------------

### Steam3Session Constructor

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Steam3Session.md

Initializes a Steam3Session with a SteamUser.LogOnDetails object, creating SteamClient and its protocol handlers, subscribing callbacks, and connecting to Steam3.

```APIDOC
## Steam3Session Constructor

### Description
Creates a new Steam3Session that wraps a SteamClient and its protocol handlers, establishes a connection to Steam3, and subscribes necessary callbacks for login and license events.

### Method
Constructor

### Parameters
- **details** (SteamUser.LogOnDetails) - Required - Contains username, password, access token, remember-password flag, and login ID for authentication.

### Example
```csharp
var details = new SteamUser.LogOnDetails
{
    Username = "user",
    Password = "pass",
    AccessToken = null,
    ShouldRememberPassword = true
};
var session = new Steam3Session(details);
```
```

--------------------------------

### Ansi.Init()

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Initializes ANSI progress support by detecting terminal capabilities. No-ops when stdin/stdout is redirected or on Linux, otherwise enables progress output if ANSI is supported and the console is not legacy.

```APIDOC
## Ansi.Init()

### Description
Initializes ANSI progress support by detecting terminal capabilities. No-ops when stdin/stdout is redirected or on Linux, otherwise enables progress output if ANSI is supported and the console is not legacy.

### Method
Init

### Signature
```csharp
public static void Init()
```

### Parameters
None.

### Return Value
void

### Remarks
- No-ops when stdin or stdout is redirected, or on Linux.
- Runs `AnsiDetector.Detect(stdError: false, upgrade: true)` and enables `useProgress` only when ANSI is supported and the console is not a legacy console.
```

--------------------------------

### LoadFromFile method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Static method that loads a ProtoManifest from a file. Returns null and sets checksum to null if the file does not exist; otherwise decompresses the deflate stream, computes SHA-1 checksum, and deserializes.

```csharp
public static ProtoManifest LoadFromFile(string filename, out byte[] checksum)
```

--------------------------------

### DownloadAppAsync

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

Asynchronously downloads a Steam app and its depots. Handles depot discovery, filtering, and downloading. Throws ContentDownloaderException on various errors such as no depots found or access denied.

```APIDOC
## DownloadAppAsync

### Description
Asynchronously downloads a Steam app and its depots. Handles depot discovery, filtering, and downloading. Throws ContentDownloaderException on various errors such as no depots found or access denied.

### Method
`public static async Task DownloadAppAsync(uint appId, List<(uint depotId, ulong manifestId)> depotManifestIds, string branch, string os, string arch, string language, bool lv, bool isUgc)`

### Parameters
- **appId** (uint) - Required - Steam AppID to download.
- **depotManifestIds** (List<(uint depotId, ulong manifestId)>) - Required - Explicit depot→manifest pairs; empty list means "all matching depots".
- **branch** (string) - Required - Branch name (e.g. `"public"`, `"beta"`).
- **os** (string) - Required* - OS filter (`windows`/`macos`/`linux`); `null` = current OS.
- **arch** (string) - Required* - Arch filter (`32`/`64`); `null` = host arch.
- **language** (string) - Required* - Language filter; `null` = `"english"`.
- **lv** (bool) - Required - Include low-violence depots.
- **isUgc** (bool) - Required - Resolve workshop depot for UGC content IDs.

\* `os`/`arch`/`language` are only consulted when the corresponding `DownloadAll*` flag is false.

### Returns
A Task representing the asynchronous operation.

### Exceptions
- **ContentDownloaderException** - Thrown when the app is not available from the account, no depots are found, or a specified depot is not listed for the app.
- **OperationCanceledException** - Thrown when the download is canceled; the app is not completely downloaded.
```

--------------------------------

### VerifyConsoleLaunch

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/PlatformUtilities.md

Windows-only method that verifies the process was launched from a real console. If not, shows a warning MessageBox. No-op when launched from a real console.

```APIDOC
## VerifyConsoleLaunch

### Description
Windows-only method that checks if the process is the only console process. If the user double-clicked the binary instead of running from a terminal, it shows a warning MessageBox explaining that DepotDownloader is a console application with no GUI.

### Method
VerifyConsoleLaunch

### Signature
`[SupportedOSPlatform("windows5.0")] public static void VerifyConsoleLaunch()`

### Parameters
None.

### Behavior
- Calls GetConsoleProcessList.
- If the process is the only console process, shows a MessageBox with title "Depot Downloader" and a message explaining that running with no parameters prints usage info and exits.
- No-op when launched from a real console.

### Example
```csharp
if (OperatingSystem.IsWindowsVersionAtLeast(5, 0))
{
    PlatformUtilities.VerifyConsoleLaunch();
}
```
```

--------------------------------

### ProtoManifest.ConvertToSteamManifest

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Converts the legacy manifest into a SteamKit2 DepotManifest, computing total compressed/uncompressed sizes, normalizing file-name hashes, and setting appropriate flags.

```APIDOC
## ConvertToSteamManifest

### Description
Converts the legacy manifest into a SteamKit2 DepotManifest, computing total compressed/uncompressed sizes, normalizing file-name hashes, and setting appropriate flags.

### Method
Instance method

### Signature
```csharp
public DepotManifest ConvertToSteamManifest(uint depotId)
```

### Parameters
- **depotId** (uint) - Required - The depot ID to set in the converted manifest.

### Returns
- **DepotManifest** - The converted SteamKit2 DepotManifest.

### Remarks
- Computes total compressed and uncompressed sizes.
- Lowercases and backslash-normalizes file-name hashes: SHA1.HashData(Encoding.UTF8.GetBytes(file.FileName.Replace('/', '\\').ToLowerInvariant())).
- Sets FilenamesEncrypted = false and EncryptedCRC = 0.
- Copies ID, CreationTime, and DepotID from the legacy manifest.
```

--------------------------------

### Download depots for an app

Source: https://github.com/steamre/depotdownloader/blob/master/README.md

Download one or all depots for a specific app using the -app, -depot, and -manifest parameters.

```powershell
./DepotDownloader -app <id> [-depot <id> [-manifest <id>]]
                 [-username <username> [-password <password>]] [other options]
```

```powershell
./DepotDownloader -app 730 -depot 731 -manifest 7617088375292372759
```

--------------------------------

### SaveManifestToFile method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Writes <depotId>_<manifestGID>.manifest plus a .sha sidecar. Returns true on success, false when serialization throws.

```csharp
public static bool SaveManifestToFile(string directory, DepotManifest manifest)
```

--------------------------------

### ProtoManifest.SaveToFile

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Serializes the manifest to a deflate-compressed file and outputs the SHA-1 checksum of the serialized bytes.

```APIDOC
## SaveToFile

### Description
Serializes the manifest to a deflate-compressed file and outputs the SHA-1 checksum of the serialized bytes.

### Method
Instance method

### Signature
```csharp
public void SaveToFile(string filename, out byte[] checksum)
```

### Parameters
- **filename** (string) - Required - The path to the output file.
- **checksum** (out byte[]) - Required - Output parameter that receives the SHA-1 checksum of the serialized bytes.

### Returns
- **void** - No return value.

### Remarks
- Serializes the manifest to a deflate-compressed file.
- Computes checksum as SHA1.HashData of the serialized bytes.
```

--------------------------------

### UpdateServerList

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Fetches the list of Steam CDN servers for the app, sets the proxy server if advertised, and builds a weighted round-robin list of eligible servers. Throws an exception if no eligible servers are found.

```APIDOC
## UpdateServerList

### Description
Fetches servers via steamSession.steamContent.GetServersForSteamPipe(). Sets ProxyServer to the first server with UseAsProxy. Builds a weighted list of servers eligible for the appId, ordered by ContentServerPenalty then WeightedLoad, adding each server NumEntries times.

### Method
UpdateServerList

### Signature
public async Task UpdateServerList()

### Parameters
None

### Exceptions
- **Exception** - Thrown when no eligible download servers are found.

### Source
DepotDownloader/CDNClientPool.cs:32
```

--------------------------------

### ProtoManifest constructors

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Shows the private parameterless constructor used for protobuf deserialization and the public constructor that copies data from a SteamKit2 DepotManifest.

```csharp
private ProtoManifest()   // proto deserialization ctor (empty Files list)
public ProtoManifest(DepotManifest sourceManifest, ulong id) : this()
```

--------------------------------

### Ansi.Progress(ulong downloaded, ulong total)

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Computes a percentage byte from downloaded/total and emits a progress bar with the Default state. This overload is used to display download progress as a percentage.

```APIDOC
## Ansi.Progress(ulong downloaded, ulong total)

### Description
Computes a percentage byte from `downloaded / total` (rounded to an integer percent, clamped to a byte) and calls the second overload with `ProgressState.Default`. Emits the progress escape sequence only when ANSI progress is enabled.

### Method
Static method

### Signature
```csharp
public static void Progress(ulong downloaded, ulong total)
```

### Parameters
- **downloaded** (ulong) - Required - The number of bytes downloaded so far.
- **total** (ulong) - Required - The total number of bytes to download.

### Behavior
- Computes percentage as `downloaded / total` rounded to integer percent, clamped to byte.
- Calls the second overload with `ProgressState.Default` and the computed percentage.
- Emits the escape sequence only when `useProgress` is true.

### Example
```csharp
Ansi.Progress(totalBytesUncompressed, completeDownloadSize);
```
```

--------------------------------

### DownloadUGCAsync

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

Downloads a single UGC handle. For non-anonymous accounts it queries Steam3Session.GetUGCDetails(ugcId); if the result has a URL the file is fetched directly via DownloadWebFile, otherwise it falls back to DownloadAppAsync. Anonymous accounts cannot query UGC details and always use the fallback path.

```APIDOC
## DownloadUGCAsync

### Description
Downloads a single UGC handle. For non-anonymous accounts it queries `Steam3Session.GetUGCDetails(ugcId)`; if the result has a `URL` the file is fetched directly via `DownloadWebFile`, otherwise it falls back to `DownloadAppAsync(appId, [(appId, ugcId)], DEFAULT_BRANCH, null, null, null, false, true)`. Anonymous accounts cannot query UGC details and always use the fallback path.

### Method
`public static async Task DownloadUGCAsync(uint appId, ulong ugcId)`

### Parameters
- **appId** (uint) - Required - The Steam application ID.
- **ugcId** (ulong) - Required - The UGC handle to download.

### Returns
A `Task` representing the asynchronous operation.
```

--------------------------------

### Download depot anonymously with -app and -depot

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Program.md

Downloads depot 731 of app 730 anonymously. The exit code is returned from Program.Main, which is internal; the real invocation is ./DepotDownloader -app 730 -depot 731 from a shell.

```csharp
var exitCode = await Program.Main(new[] { "-app", "730", "-depot", "731" });
```

--------------------------------

### ConvertToSteamManifest method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Converts the legacy manifest into a SteamKit2 DepotManifest, computing total sizes, normalizing file-name hashes, and setting specific properties.

```csharp
public DepotManifest ConvertToSteamManifest(uint depotId)
```

--------------------------------

### RequestPackageInfo

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Steam3Session.md

Requests PICS product info for packages, skipping already-cached ids, caching into `PackageInfo`.

```APIDOC
```csharp
public async Task RequestPackageInfo(IEnumerable<uint> packageIds)
```
```

--------------------------------

### Download workshop item using ugc id

Source: https://github.com/steamre/depotdownloader/blob/master/README.md

Download a workshop item by specifying the app ID and the UGC ID.

```powershell
./DepotDownloader -app <id> -ugc <id> [-username <username> [-password <password>]]
```

```powershell
./DepotDownloader -app 730 -ugc 770604181014286929
```

--------------------------------

### Usage by ContentDownloader during depot update

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/DepotConfigStore.md

Shows how ContentDownloader uses the store: load the config, read the previous manifest ID, invalidate it for early-exit safety, and record the new manifest ID on success. The invalidation forces re-verification on the next run if the process exits early.

```csharp
// How ContentDownloader uses the store during a depot update
DepotConfigStore.LoadFromFile(Path.Combine(configDir, "depot.config"));

DepotConfigStore.Instance.InstalledManifestIDs.TryGetValue(731, out var lastManifestId);
var previousManifest = Util.LoadManifestFromFile(configDir, 731, lastManifestId, badHashWarning: true);

// Early-exit safety: invalidate the record until the download completes
DepotConfigStore.Instance.InstalledManifestIDs[731] = ContentDownloader.INVALID_MANIFEST_ID;
DepotConfigStore.Save();

// ... download ...

// On success, record the newly installed manifest
DepotConfigStore.Instance.InstalledManifestIDs[731] = depot.ManifestId;
DepotConfigStore.Save();
```

--------------------------------

### GetSteamOS method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Util.md

Returns the operating system identifier: "windows", "macos", "linux", or "unknown". FreeBSD returns "linux" because the Steam client does not exist for FreeBSD. Used as the default -os depot filter.

```csharp
public static string GetSteamOS()
```

--------------------------------

### Ansi.Progress(ulong downloaded, ulong total)

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Computes a percentage byte from downloaded/total and calls the state-based overload with ProgressState.Default. Emits the progress escape sequence when ANSI progress is enabled.

```APIDOC
## Ansi.Progress(ulong downloaded, ulong total)

### Description
Computes a percentage byte from `downloaded / total` (rounded to an integer percent, clamped to a byte) and calls the second overload with `ProgressState.Default`. Emits the escape sequence only when progress is enabled.

### Method
Progress

### Parameters
#### Parameters
- **downloaded** (ulong) - Required - The number of bytes downloaded so far.
- **total** (ulong) - Required - The total number of bytes to download.

### Response
No return value.
```

--------------------------------

### ReturnConnection method

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Records a healthy connection return (currently a no-op beyond the null guard).

```csharp
public void ReturnConnection(Server server)
```

--------------------------------

### Ansi.Progress(ulong downloaded, ulong total)

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/Ansi.md

Computes a percentage from downloaded/total and emits a default progress bar. This overload is used during chunk downloads to show a percentage-based progress bar.

```APIDOC
## Ansi.Progress(ulong downloaded, ulong total)

### Description
Computes a percentage byte from `downloaded / total` (rounded to an integer percent, clamped to a byte) and calls the second overload with `ProgressState.Default`. Emits the progress escape sequence only when ANSI progress is enabled.

### Method
Static method

### Signature
`public static void Progress(ulong downloaded, ulong total)`

### Parameters
- **downloaded** (ulong) - Required - The number of bytes downloaded so far.
- **total** (ulong) - Required - The total number of bytes to download.

### Behavior
- Computes percentage as `downloaded / total` rounded to an integer percent, clamped to a byte.
- Calls the `Progress(ProgressState, byte)` overload with `ProgressState.Default` and the computed percentage.
- Emits the escape sequence only when `useProgress` is true.

### Example
```csharp
Ansi.Progress(totalBytesUncompressed, completeDownloadSize);
```
```

--------------------------------

### ProtoManifest and nested FileData protobuf contract

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/types.md

Defines the protobuf manifest with Files, ID, and CreationTime, plus the nested FileData contract holding FileName, Chunks, Flags. Used for serialized depot manifest storage.

```csharp
[ProtoContract]
class ProtoManifest
{
    [ProtoMember(1)] public List<FileData> Files { get; private set; }
    [ProtoMember(2)] public ulong ID { get; private set; }
    [ProtoMember(3)] public DateTime CreationTime { get; private set; }

    [ProtoContract]
    public class FileData
    {
        [ProtoMember(1)] public string FileName { get; internal set; }
        [ProtoMember(2)] public List<ChunkData> Chunks { get; private set; }
        [ProtoMember(3)] public EDepotFileFlag Flags { get; private set; }
        [ProtoMember(4)] public ulong Size { get; private set; }
    }
}
```

--------------------------------

### SaveToFile method signature

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ProtoManifest.md

Instance method that serializes the manifest to a deflate-compressed file and outputs the SHA-1 of the serialized bytes.

```csharp
public void SaveToFile(string filename, out byte[] checksum)
```

--------------------------------

### GetConnection method

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/CDNClientPool.md

Returns servers[nextServer % servers.Count] (round-robin). Callers must have called UpdateServerList first.

```csharp
public Server GetConnection()
```

--------------------------------

### Tuple type used by DownloadAppAsync

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/types.md

The `depotManifestIds` parameter of `ContentDownloader.DownloadAppAsync` is a list of `(uint depotId, ulong manifestId)` tuples, produced by `Program.Main` by zipping the `-depot` and `-manifest` argument lists.

```csharp
List<(uint depotId, ulong manifestId)>
```

--------------------------------

### ContentDownloader Config property

Source: https://github.com/steamre/depotdownloader/blob/master/_autodocs/api-reference/ContentDownloader.md

The single process-wide configuration object. Program.Main mutates it directly from CLI parameters; ContentDownloader and Steam3Session read it.

```csharp
public static DownloadConfig Config = new();
```
Tokens:
Raw