cm2network/steampipe

cm2network/steampipe 镜像文档

镜像概述和主要用途

cm2network/steampipe 是基于 Docker 的 SteamPipe ContentBuilder 工具镜像，用于将游戏或应用构建上传至 Valve 的 Steam 平台。SteamPipe 是 Steam 的游戏/应用内容分发系统，提供高效内容交付、多分支测试等功能。该镜像专注于实现 ContentBuilder 功能，帮助开发者通过 CI/CD 流程将构建上传至 Steam 应用的 depots（内容仓库）和分支，无需完整安装 Steamworks SDK。

核心功能和特性

• 轻量级依赖：仅依赖 SteamCMD 安装，无需完整 Steamworks SDK，符合 SDK 许可协议
• 目录结构模拟：复制 Steamworks SDK 最小化目录结构，确保兼容性
• 构建缓存支持：通过持久化卷保存构建缓存，避免重复从零开始构建
• 灵活配置：支持环境变量自定义构建参数，或通过自定义 VDF 文件实现复杂部署
• 登录会话持久化：通过卷保存 Steam 登录会话，避免重复输入 Steam Guard 验证码

支持的标签

使用场景和适用范围

适用对象

游戏或应用开发者，需要通过自动化流程（如 CI/CD）将构建上传至 Steam 平台。

前置条件

1. 已在 Steam 合作伙伴后台 创建应用（AppID）、内容仓库（DepotID）和分支（Branch）
2. 拥有具备上传权限的 Steamworks 账号（需启用*** Steam Guard）
3. 熟悉 SteamPipe 官方文档，已完成基础配置（参考 Steam 上传文档）

使用方法

前置准备

确保满足以下条件：

• Docker 环境已安装并运行
• 目标构建文件已准备（如 CI 流程生成的游戏包）
• Steamworks 账号权限正确（可上传至目标 Depot）

初始化设置（一次性操作）

1. 创建持久化卷

需创建以下卷保存登录会话、构建缓存和 SteamCMD 安装（可选）：

bash
# 登录会话存储（保存 Steam 登录状态，避免重复验证）
docker volume create steamcmd_login_volume  

# 构建缓存存储（必须保留，避免每次构建从零开始）
docker volume create steamcmd_output_volume  

# SteamCMD 安装目录（可选，避免重复下载安装）
docker volume create steamcmd_volume  

2. 激活 Steam 登录会话

执行以下命令初始化登录会话，首次运行需输入*** Steam Guard 验证码（会话将永久保存至 steamcmd_login_volume）：

bash
docker run -it --rm \
  -v "steamcmd_login_volume:/home/steam/Steam:z" \
  -v "steamcmd_volume:/home/steam/steamcmd:z" \
  cm2network/steampipe:contentbuilder \
  bash /home/steam/steamcmd/steamcmd.sh +login [STEAMUSER] [ACCOUNTPASSWORD] +quit

参数说明：

• [STEAMUSER]：Steamworks 账号用户名
• [ACCOUNTPASSWORD]：账号密码

上传构建至 Steam

方式一：简单上传（单 Depot）

适用于仅需上传至单个 Depot 的场景。替换以下参数后执行：

bash
docker run -d --net=host \
  -e STEAMUSER="[STEAMUSER]" \          # Steam 用户名  
  -e STEAMPASSWORD="[ACCOUNTPASSWORD]" \# Steam 密码  
  -e STEAMAPPID="[STEAMAPPID]" \        # 应用 ID（如 12345）  
  -e STEAMDEPOTID="[STEAMDEPOTID]" \    # Depot ID（如 12346）  
  -e STEAMAPPBUILDESC="Automated CD Upload" \  # 构建描述（显示在 Steam 后台）  
  -v "[UPLOADDIR]:/home/steam/steamsdk/sdk/tools/ContentBuilder/content" \  # 本地构建文件路径（如 ./build）  
  -v "steamcmd_login_volume:/home/steam/Steam:z" \  
  -v "steamcmd_volume:/home/steam/steamcmd:z" \  
  -v "steamcmd_output_volume:/home/steam/steamsdk/sdk/tools/ContentBuilder/output" \  
  --rm "cm2network/steampipe:contentbuilder"  

方式二：复杂上传（自定义 VDF 文件）

适用于多 Depot 上传或需自定义构建逻辑的场景，通过 VDF 文件定义构建规则。替换以下参数后执行：

bash
docker run -d --net=host \
  -e STEAMUSER="[STEAMUSER]" \          # Steam 用户名  
  -e STEAMPASSWORD="[ACCOUNTPASSWORD]" \# Steam 密码  
  -e VDFAPPBUILD="[VDFAPPBUILDFILE]" \  # 自定义 VDF 文件名（如 app_build_12345.vdf）  
  -e STEAMAPPBUILDESC="Automated CD Upload" \  # 构建描述  
  -v "[UPLOADDIR]:/home/steam/steamsdk/sdk/tools/ContentBuilder/content" \  # 本地构建文件路径  
  -v "[VDFFILESDIR]:/home/steam/steamsdk/sdk/tools/ContentBuilder/scripts" \  # 本地 VDF 文件目录（存放自定义 VDF）  
  -v "steamcmd_login_volume:/home/steam/Steam:z" \  
  -v "steamcmd_volume:/home/steam/steamcmd:z" \  
  -v "steamcmd_output_volume:/home/steam/steamsdk/sdk/tools/ContentBuilder/output" \  
  --rm "cm2network/steampipe:contentbuilder"  

配置说明

环境变量

可通过 -e 参数覆盖以下环境变量，自定义构建行为：

贡献者