CloudRedirect Documentation

CloudRedirect operates by intercepting Steam's internal cloud save RPC handlers.

On Windows: It uses a C++ DLL and a WPF companion app. The companion app copies the DLL to your Steam folder and handles cloud provider authentication. The DLL hooks Steam's internal handlers to intercept read/write calls. If a game is owned, it uses standard Steam Cloud; if it is a 'lua' game, the DLL redirects the data to your chosen cloud provider.

On Linux: It uses a library loaded at Steam startup and a Flatpak application for configuration.

Building on Linux requires specific environment constraints:

• glibc requirement: You must build against glibc 2.31 or older (e.g., Ubuntu 20.04, Debian 11).
• Toolchain: GCC 12 and 32-bit multilib are required if building on Ubuntu 20.04.
• CMake: A modern version of CMake is required (system versions may be too old).

Build Command: When running CMake, you must specify the 32-bit flag:

-DLINUX_32BIT=ON

Note: It is highly recommended to use Distrobox to manage these specific environment requirements.

Prerequisites

• Visual Studio 2022 (or Build Tools) with C++ and .NET 8 workloads
• CMake 3.20+

Build Steps

Run the following commands to build the C++ DLL and the WPF application:

cmake -B build -G "Visual Studio 17 2022" -A x64
cmake --build build --config Release

Outputs:

• C++ DLL: build/Release/cloud_redirect.dll
• WPF App: ui/bin/publish/CloudRedirect.exe (The DLL is automatically embedded into this executable).

CloudRedirect uses a provider-based model to abstract different cloud storage services.

Key Concepts

• Active Provider: The provider currently configured in config.json. If no cloud provider is selected, it defaults to local.
• Provider Labels: While internal keys might be short (e.g., gdrive), the providerLabel(provider) method returns human-readable names (e.g., Google Drive).
• Authentication: Providers can be authenticated via OAuth (using startOAuth(provider)) or via direct credential files (S3/R2). The providerAuthenticated property indicates if the current provider is ready for use.
• Scanning: The scanProvider(provider) method triggers a full scan of a provider's cloud storage via the CLI scan-all command to identify existing cloud backups.

When using the Google Drive provider, CloudRedirect maps flat logical paths to a specific folder hierarchy within Google Drive.

Logical Path Format: {accountId}/{appId}/blobs/{filename}

Google Drive Hierarchy: CloudRedirect/{accountId}/{appId}/...

This mapping ensures that files are organized under a root CloudRedirect folder, subdivided by account and application IDs.

The CloudRedirect CLI allows you to manage cloud providers, remote applications, and blobs directly from the command line. All command output is returned as JSON to stdout.

Exit Codes:

• 0: Success
• 1: Error

Execution Syntax:

• Windows: cloud_redirect_cli.exe <command> [args...]
• Linux: cloud_redirect_cli <command> [args...]

# Example usage pattern
cloud_redirect_cli list-remote-apps <provider>

The CloudRedirect CLI is invoked using the --cli flag followed by a specific command and its required arguments. The CLI outputs results in JSON format. A successful operation is indicated by an exit code of 0 and a JSON response containing "success":true or "authenticated":true.

Supported providers include: gdrive, onedrive, r2, and s3.

cloud_redirect --cli <command> [args...]

When using custom or internal cloud storage (like MinIO or Garage), you can configure the HTTP transport to allow insecure connections or custom certificate authorities using the TransportOptions struct.

Key options:

• allowInsecureHttp: Set to true to permit plaintext http:// connections.
• allowInsecureTls: Set to true to skip TLS certificate verification (useful for self-signed certificates).
• caCertPath: Provide a path to a custom CA bundle for internal CAs.

TransportOptions options;
options.allowInsecureHttp = true;
options.allowInsecureTls = true;
options.caCertPath = "/path/to/ca-bundle.crt";

transport->SetOptions(options);