You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-63Lines changed: 12 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ A GitHub Action for uploading an [app build](https://partner.steamgames.com/doc/
4
4
5
5
## How to use
6
6
7
-
This action assumes you are registered as a [partner](https://partner.steamgames.com/) with Steam.
7
+
- This action assumes you are registered as a [partner](https://partner.steamgames.com/) with Steam.
8
+
- This action assumes you have MFA enabled on your Steam account, and the Steam Mobile app installed on your phone.
9
+
- This action also assumes some secrets to be set in your repository:
8
10
9
-
This action also assumes some secrets to be set in your repository:
11
+
> [!IMPORTANT]
12
+
> You will be prompted to accept the login from the Steam Mobile app on your phone when the action runs the first time.
13
+
> Subsequent runs will attempt to use the cached login credentials, but may from time to time require you to accept the login again.
10
14
11
-
*`STEAM_USERNAME`: The username of your steamworks build account
12
-
*`STEAM_PASSWORD`: The password for the account
13
-
*`STEAM_SHARED_SECRET`: Optional, a SteamGuard shared secret ([setup steps](#shared-secret))
14
-
*`STEAM_CONFIG`: Optional, a steam account config.vdf encoded as base64 string ([setup steps](#config))
15
-
*`STEAM_SSFN`: Optional, a steam ssfn file encoded as base64 string. Optional, with `STEAM_CONFIG` setup.
16
-
*`STEAM_SSFN_NAME`: Optional, the name of the `STEAM_SSFN` file that was encoded. Required with `STEAM_SSFN`.
15
+
-`STEAM_USERNAME`: The username of your steamworks build account
16
+
-`STEAM_PASSWORD`: The password for the account
17
17
18
18
### workflow
19
19
@@ -26,7 +26,7 @@ steps:
26
26
id: upload
27
27
with:
28
28
username: ${{ secrets.STEAM_USERNAME }}
29
-
config: ${{ secrets.STEAM_CONFIG }}
29
+
password: ${{ secrets.STEAM_PASSWORD }}
30
30
app_id: 1000
31
31
description: 'Your build description here'
32
32
content_root: '${{ github.workspace }}/Build'
@@ -47,12 +47,7 @@ steps:
47
47
| Name | Description | Required |
48
48
| ---- | ----------- | -------- |
49
49
| `username` | A Steamworks [build account](https://partner.steamgames.com/doc/sdk/uploading#Build_Account) name with the "Edit App Metadata" and "Publish App Changes To Steam" permissions granted. | true |
50
-
| `password` | The password for the account. | if `config` is not provided. |
51
-
| `totp` | A temporary one time pass code (totp) from SteamGuard. | if `shared_secret` and `config` are not provided |
52
-
| `shared_secret` | The [shared secret](#shared-secret) from SteamGuard's two-factor authentication. | if `totp` and `config` are not provided. |
53
-
| `config` | Steam [config.vdf](#config) encoded as base64 string. | if `password`, `totp` and `shared_secret` are not provided. |
54
-
| `ssfn` | Steam SSFN file encoded as base64 string. This is an optional addition to `config`. | Optional, if `config` is provided. |
55
-
| `ssfn_name` | The name of the encoded `ssfn` file | if `ssfn` is provided. |
50
+
| `password` | The password for the account. | true |
56
51
| `app_id` | The app id of the game. | if `app_build` or `workshop_item` are not provided. |
57
52
| `workshop_item_id` | The `publishedfileid`. To create a new item `app_id` must be set and `workshop_item_id` be set to 0. To update an existing item, both `app_id` and `workshop_item_id` must be set. | for workshop item uploads and if `workshop_item` is not provided. |
58
53
| `description` | Either the build description or workshop item description. If an `app_build` or `workshop_item` file is provided, this will be ignored. | false |
@@ -66,55 +61,9 @@ steps:
66
61
67
62
### outputs
68
63
69
-
* `manifest`: The path to the resulting build manifest.
64
+
-`manifest`: The path to the resulting build manifest.
70
65
71
66
## Multi-Factor Authentication Setup
72
67
73
68
Deploying to Steam requires using Multi-Factor Authentication (MFA).
74
-
This action requires at least one of these authentication methods are set:
75
-
76
-
* `totp`: A temporary one time pass code (totp) from SteamGuard Authenticator app.
77
-
* `config`: Steam [config.vdf](#config) encoded as base64 string.
78
-
* `shared_secret`: The [shared secret](#shared-secret) from SteamGuard's two-factor authentication.
79
-
80
-
### Temporary One Time Pass Code
81
-
82
-
Can be obtained from SteamGuard Authenticator app. Usually is temporary and resets after a set amount of time.
83
-
84
-
### Config
85
-
86
-
To setup steamcmd for continuous integration, or just on a machine or VM that will get re-imaged frequently, you'll need to include the config file that contains your login token. Follow these steps so that your initial login token is properly saved:
0 commit comments