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
+58-10
Original file line number
Diff line number
Diff line change
@@ -87,16 +87,64 @@ Deploying to Steam using TOTP. If this is not passed, `configVdf` is required.
87
87
88
88
#### configVdf
89
89
90
-
Deploying to Steam requires using Multi-Factor Authentication (MFA) through Steam Guard unless `totp` is passed.
91
-
This means that simply using username and password isn't enough to authenticate with Steam.
92
-
However, it is possible to go through the MFA process only once by setting up GitHub Secrets for `configVdf` with these steps:
93
-
1. Install [Valve's offical steamcmd](https://partner.steamgames.com/doc/sdk/uploading#1) on your local machine. All following steps will also be done on your local machine.
94
-
1. Try to login with `steamcmd +login <username> <password> +quit`, which may prompt for the MFA code. If so, type in the MFA code that was emailed to your builder account's email address.
95
-
1. Validate that the MFA process is complete by running `steamcmd +login <username> +quit` again. It should not ask for the MFA code again.
96
-
1. The folder from which you run `steamcmd` will now contain an updated `config/config.vdf` file. Use `cat config/config.vdf | base64 > config_base64.txt` to encode the file. Copy the contents of `config_base64.txt` to a GitHub Secret `STEAM_CONFIG_VDF`.
1. `If:` when running the action you recieve another MFA code via email, run `steamcmd +set_steam_guard_code <code>` on your local machine and repeat the `config.vdf` encoding and replace secret `STEAM_CONFIG_VDF` with its contents.
99
-
2. If the action fails with `Logging in user ... to Steam Public...FAILED (License expired)`, then you need to regenerate your local VDF file with a new Steam guard code.
90
+
Steam Deploy supports two authentication methods:
91
+
92
+
1. **Time-based One-Time Password (TOTP)** - Recommended if you have access to the shared secret.
93
+
2. **Steam Guard MFA with `config.vdf`** - An alternative method requiring a one-time setup.
94
+
95
+
If you are using the `config.vdf` method, follow these steps to set up the required GitHub Secret:
96
+
97
+
1. **Install steamcmd**
98
+
Install [Valve's official steamcmd](https://partner.steamgames.com/doc/sdk/uploading#1) on your local machine. All subsequent steps will also be performed on your local machine.
99
+
100
+
2. **Log in to Steam using steamcmd**
101
+
Run the following command to log in:
102
+
```bash
103
+
steamcmd +login <username> <password> +quit
104
+
```
105
+
If prompted, check your email for the MFA code and provide it when requested.
106
+
107
+
3. **Validate MFA completion**
108
+
To ensure MFA is complete, run:
109
+
```bash
110
+
steamcmd +login <username> +quit
111
+
```
112
+
If no MFA prompt appears, proceed to the next step.
113
+
114
+
4. **Locate and encode the `config.vdf` file**
115
+
The location of the `config.vdf` file depends on your operating system:
116
+
- **Windows/Linux**: The file is in the `config/config.vdf` relative to where you ran `steamcmd`.
117
+
- **macOS**: The file is located at `~/Library/Application Support/Steam/config/config.vdf`.
0 commit comments