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.

Warning

Does not support trimming or AOT - this stems from DepotDownloader itself.
Make sure <PublishTrimmed> and <PublishAot> are not true.

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 call:

CancellationTokenSource cts = new CancellationTokenSource();

var cfg = new DepotDownloader.AppDownloadConfig
{
    // AccountSettingsFileName = "custom.config",
    // Username = "user",
    // Password = "pass",
    InstallDirectory = "C:/apps/244310",
    VerifyAll = true,
    AppId = 244310
};

Method A) Using an async enumerable:

int? exitCode = null;
await foreach ((string message, bool error) in DepotDownloader.SubProcess.AppDownload(
        cfg, ec => exitCode = ec, new UserConsoleAuthenticator(), cts.Token))
{
    Console.WriteLine("DepotDownloader: " + message);
}

if (exitCode != DepotDownloader.SubProcess.Success)
{
    Console.WriteLine("Download failed");
}

Method B) Using a task and message callbacks:

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

int exitCode = await DepotDownloader.SubProcess.AppDownload(
        cfg, MessageHandler, MessageHandler, new UserConsoleAuthenticator(), cts.Token);

if (exitCode != DepotDownloader.SubProcess.Success)
{
    Console.WriteLine("Download failed");
}

Pubfile (Workshop) download

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

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

UGC (Workshop) download

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

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