Skip to content

Commit be98464

Browse files
Update documentation for different platforms (#45)
* Update documentation for different platforms Update documentation for different platforms * Spellcheck Co-authored-by: Webber Takken <webber@takken.io>
1 parent 0b3710e commit be98464

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ However, it is possible to go through the MFA process only once by setting up Gi
6969
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.
7070
1. Validate that the MFA process is complete by running `steamcmd +login <username> <password> +quit` again. It should not ask for the MFA code again.
7171
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`.
72-
1. That folder will also contain two files whose names look like `ssfn<numbers>`, **but one of them is a hidden file**. [Find the hidden one](https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5), then copy the name of that file to a GitHub Secret `STEAM_SSFN_FILE_NAME`.
73-
1. Use `cat <ssfnFileName> | base64 > ssfn_base64.txt` to encode the contents of the hidden ssfn file. Copy the contents of `ssfn_base64.txt` to a GitHub Secret `STEAM_SSFN_FILE_CONTENTS`.
72+
1. Find the SSFN file, depending on your platform. **Windows**: The `steamcmd` folder will also contain two files of which the names look like `ssfn<numbers>`. **One of them is a hidden file**. [Find that hidden file](https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5) and use that hidden file as the correct SSFN file for the following steps. **Linux**: The SSFN file will be in the `steamcmd` folder. **Mac**: The SSFN will be at `~/Library/Application\ Support/Steam/`.
73+
1. Copy the name of the SSFN file to a GitHub Secret `STEAM_SSFN_FILE_NAME`.
74+
1. Use `cat <ssfnFileName> | base64 > ssfn_base64.txt` to encode the contents of the SSFN file. Copy the encoded contents inside `ssfn_base64.txt` to a GitHub Secret called `STEAM_SSFN_FILE_CONTENTS`.
7475

7576
#### appId
7677

@@ -110,10 +111,6 @@ Note that the `default` branch [has been observed to not work](https://github.co
110111

111112
## Other Notes
112113

113-
#### Environment Support
114-
115-
steam-deploy only supports `ubuntu` environments. It will not work in `macos` or `windows` environments.
116-
117114
#### Excluded Files / Folders
118115

119116
Certain file or folder patterns are excluded from the upload to Steam as they're unsafe to ship to players:

0 commit comments

Comments
 (0)