DepotDownloaderSubProcess 3.4.0-sp1

DepotDownloaderSubProcess

A C# API wrapping Steam depot downloader in a sub-process utilizing Tmds.ExecFunction library.

This avoids many pitfalls of calling the original utility that has been specifically written for CLI usage. Original code remains largely unchanged to facilitate easy sync with upstream.

Usage

As per ExecFunction documentation, add the following to your Main method.

public static int Main(string[] args)
{
    // Starting a subprocess function? [Tmds.ExecFunction]
    if (ExecFunction.IsExecFunctionCommand(args))
    {
        return ExecFunction.Program.Main(args);
    }

    // Start normally..
}

App download

Prepare inputs:

var cts = new CancellationTokenSource();
var authenticator = new UserConsoleAuthenticator();
var cfg = new AppDownloadConfig
{
    // AccountSettingsFileName = "custom.config",
    // Username = "user",
    // Password = "pass",
    InstallDirectory = "C:/apps/244310",
    VerifyAll = true,
    AppId = 244310
};

Method A) Using an async enumerable:

try
{
    await foreach (var (message, isError) in DepotDownloaderApi.AppDownload(cfg, authenticator, cts.Token))
    {
        Console.WriteLine("DepotDownloader: " + message);
    }
}
catch (DepotDownloaderApiException e)
{
    Console.WriteLine("Download failed: " + e.Message);
}

Method B) Using a task and message callbacks:

void MessageHandler(object sender, DataReceivedEventArgs e)
{
    if (e.Data != null) Console.WriteLine("DepotDownloader: " + e.Data);
}

try
{
    await DepotDownloaderApi.AppDownload(cfg, MessageHandler, MessageHandler, authenticator, cts.Token);
}
catch (DepotDownloaderApiException e)
{
    Console.WriteLine("Download failed: " + e.Message);
}

Pubfile (Workshop) download

Pubfile download is similiar to App download, but uses PubFileDownloadConfig :

var cfg = new PubFileDownloadConfig
{
    AppId = ...,
    PublishedFileId = ...
};
... DepotDownloaderApi.PubFileDownload(cfg, ...)

UGC (Workshop) download

UGC download is similiar to App download, but uses UGCDownloadConfig :

var cfg = new UGCDownloadConfig
{
    AppId = ...,
    UGCId = ...
};
... DepotDownloaderApi.UGCDownload(cfg, ...)

Get app Build ID

Returns most recent build ID for an app and a branch (default: public)
Internally delegates to GetAppBranches call.

try
{
    uint buildId = await DepotDownloaderApi.GetAppBuildId(appId);
}
catch (DepotDownloaderApiException e)
{
    Console.WriteLine("Build ID check failed: " + e.Message);
}

Get app branches

Returns a list of available branches and their details (Name, BuildId, Description, PasswordRequired, TimeUpdated) for an app:

try
{
    List<AppBranchInfo> branches = await DepotDownloaderApi.GetAppBranches(appId);
}
catch (DepotDownloaderApiException e)
{
    Console.WriteLine("Branch check failed: " + e.Message);
}

Get local install info

Reads local install status (State, AppId, Branch, BuildId, Depots) from the metadata in .DepotDownloader/depot.json:

try
{
    LocalInstallInfo installInfo = DepotDownloaderApi.GetLocalInstallInfo("C:/apps/244310");
}
catch (DepotDownloaderApiException e)
{
    Console.WriteLine("Failed to read install info: " + e.Message);
}