Steam-Deploy 开源项目教程

Steam-Deploy 开源项目教程

steam-deployGithub Action to deploy a game to Steam项目地址:https://gitcode.com/gh_mirrors/st/steam-deploy

项目介绍

Steam-Deploy 是一个 GitHub Action，用于将游戏构建部署到 Steam 平台。该项目由 game-ci 社区维护，旨在简化游戏开发者将作品发布到 Steam 的过程。通过 Steam-Deploy，开发者可以自动化部署流程，减少手动操作，提高效率。

项目快速启动

安装与配置

要使用 Steam-Deploy，首先需要在 GitHub 仓库中添加相应的配置文件。以下是一个基本的配置示例：

name: Deploy to Steam
on: [push]

jobs:
  deployToSteam:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Steam Deploy
        uses: game-ci/steam-deploy@v3
        with:
          username: ${{ secrets.STEAM_USERNAME }}
          configVdf: ${{ secrets.STEAM_CONFIG_VDF }}
          appId: 1234560
          buildDescription: v1.2.3
          rootPath: build
          depot1Path: StandaloneWindows64
          depot1InstallScriptPath: StandaloneWindows64/install_script.vdf
          depot2Path: StandaloneLinux64
          releaseBranch: prerelease

配置参数说明

• username: Steam 构建账户的用户名。
• configVdf: Steam 配置文件的路径。
• appId: 游戏的应用 ID。
• buildDescription: 构建描述。
• rootPath: 构建文件的根路径。
• depot1Path: 第一个 depot 的路径。
• depot1InstallScriptPath: 第一个 depot 的安装脚本路径。
• depot2Path: 第二个 depot 的路径。
• releaseBranch: 发布分支。

应用案例和最佳实践

应用案例

假设你是一名独立游戏开发者，希望将你的游戏自动部署到 Steam。通过使用 Steam-Deploy，你可以设置一个 GitHub Actions 工作流，每当有新的代码推送时，自动构建并部署到 Steam。

最佳实践

1. 使用 GitHub Secrets: 将敏感信息如用户名、密码等存储在 GitHub Secrets 中，确保安全性。
2. 版本控制: 在构建描述中包含版本信息，便于追踪和管理。
3. 多平台支持: 配置多个 depot 路径，支持不同平台的构建。

典型生态项目

Steam-Deploy 作为 game-ci 社区的一部分，与其他项目协同工作，共同构建了一个完整的游戏开发和部署生态系统。以下是一些相关的生态项目：

• game-ci/unity-builder: 用于构建 Unity 项目的 GitHub Action。
• game-ci/unity-test-runner: 用于运行 Unity 测试的 GitHub Action。
• game-ci/unity-request-manual-activation-file: 用于请求 Unity 手动激活文件的 GitHub Action。

通过这些项目的组合使用，开发者可以实现从代码提交到游戏发布的全自动化流程。

steam-deployGithub Action to deploy a game to Steam项目地址:https://gitcode.com/gh_mirrors/st/steam-deploy