https://github.com/bioblaze/batch2steam
https://github.com/bioblaze/batch2steam
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bioblaze/batch2steam
- Owner: Bioblaze
- License: mit
- Created: 2025-04-20T04:11:16.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-20T23:44:36.000Z (about 1 year ago)
- Last Synced: 2025-06-06T06:43:35.698Z (about 1 year ago)
- Language: Shell
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Batch2Steam GitHub Action
## Overview
The **Batch2Steam** GitHub Action is built to batch-deploy multiple depots associated with a single Steam AppID using the SteamSDK. It enables streamlined CI/CD pipelines for game developers who need to push cross-platform or modular builds in one go.
This action connects to the Steam partner network, generates individual depot VDFs for each entry, constructs a combined app VDF, and automates the upload using SteamCMD with full TOTP (Steam Guard) support.
## Inputs
### Required Inputs
- `username`: The username of your Steam builder account.
- `password`: The password for your Steam builder account.
- `shared_secret`: The shared secret for Steam's two-factor authentication. This is used to generate a time-based one-time password.
- `appId`: The unique identifier for your application within Steam's partner network.
- `rootPath`: The root path where all depot content is located.
- `baseDesc`: This is a Description that will be added in the Default Description for the Build
- `entries`: A **JSON array** of entry objects containing:
- `depotID`: The ID of the Steam depot.
- `buildDescription`: Echoed in Debug
- `depotPath`: The subdirectory within `rootPath` where the depot's files are stored.
### Example entries input:
```json
[
{ "depotID": "123457", "buildDescription": "Windows 64-bit build", "depotPath": "windows" },
{ "depotID": "123458", "buildDescription": "Linux 32-bit build", "depotPath": "linux32" },
{ "depotID": "123459", "buildDescription": "macOS build", "depotPath": "macos" }
]
```
## Outputs
- `build_id`: The unique build ID returned after a successful upload to Steam.
## Environment Variables
These are internally used and set from your inputs:
- `steam_username`
- `steam_password`
- `steam_shared_secret`
- `appId`
- `rootPath`
- `entries`
- `baseDesc`
## Usage
Here’s an example GitHub Actions workflow that uses **Batch2Steam** to upload multiple builds:
```yaml
name: Batch Deploy to Steam
on:
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Batch Deploy to Steam
uses: bioblaze/batch2steam@v1 # Path to your action or remote repo
with:
username: ${{ secrets.STEAM_USERNAME }}
password: ${{ secrets.STEAM_PASSWORD }}
shared_secret: ${{ secrets.STEAM_SHARED_SECRET }}
appId: '123456'
rootPath: './build'
baseDesc: '1.5.12-rc'
entries: >
[
{ "depotID": "123457", "buildDescription": "Windows 64-bit build", "depotPath": "windows" },
{ "depotID": "123458", "buildDescription": "Linux 32-bit build", "depotPath": "linux32" },
{ "depotID": "123459", "buildDescription": "macOS build", "depotPath": "macos" }
]
```
In this workflow:
- All depot folders are expected to exist under `./build/`.
- VDF files for each depot and the app are generated automatically inside the action.
- The manifest is executed via SteamCMD in a single batch operation.
## Notes
- Set up GitHub Secrets for `STEAM_USERNAME`, `STEAM_PASSWORD`, and `STEAM_SHARED_SECRET` to protect your credentials.
- Each `depotPath` must be relative to the `rootPath` and must contain the full content for that depot.
- Make sure your depots are properly configured on the Steam partner site with matching Depot IDs.
## Node.js File: `get_totp.js`
This action includes a Node.js utility (`get_totp.js`) to securely generate TOTP codes for use with Steam Guard. It reads your `shared_secret` and calculates the correct authentication code for logging in.
## How to Get the Shared Token for Steam
To obtain your Steam shared secret for use with this action, follow the guide provided:
📄 [How to Get the Shared Token for Steam (STEAM_TUTORIAL.md)](./STEAM_TUTORIAL.md)
The tutorial includes:
- Installing `steamguard-cli`
- Exporting the shared token
- Securing your revocation code for future recovery
If you need help, feel free to open an issue or contact the maintainer directly.
## License
This GitHub Action is distributed under the MIT license. See the `LICENSE` file for more details.
---
Maintained by **Randolph William Aarseth II** <>. Pull requests and issues welcome.