Skip to content

Commit b9b3780

Browse files
authored
Remove Steam store example from readme (#120)
* Remove Steam store example from readme An addition to bed06bd to avoid confusion (like what happened to me). * Proccess requested changes Uses permalink for Proton.
1 parent 3f02ae2 commit b9b3780

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ What store does the game come from? GOG? Epic (egs)? Battlenet? Amazon?
143143

144144
- For games not on Steam the second part of the ID should have at least one letter, but preferably be a phrase that's easily understandable simply so that it's not parsed as a Steam ID. We perform a check on the second part of the umu ID to determine if it's numeric or not. If it is, that part is sent as the Steam ID to Proton. Protonfixes prioritizes the UMU_ID environment variable, but Proton itself uses SteamAppId for some game-specific fixes directly. So, if say the game As Dusk Falls has both protonfixes and an official Proton-specific fix. It's umu ID would be umu-1341820, which gets passed to protonfixes, while the second part of that (1341820) gets parsed and passed as the app ID (SteamAppId). This way, it allows both Valve's fixes in their proton script (and their wine code) to work as well as our protonfixes.
145145

146-
Ex from proton:
146+
Example from [upstream Proton](https://github.com/ValveSoftware/Proton/blob/155f7f2c18a04d0c04b3860ce58d4a222ac43548/proton#L1292-L1337):
147147

148148
```\
149149
           if appid in [
@@ -162,7 +162,7 @@ What store does the game come from? GOG? Epic (egs)? Battlenet? Amazon?
162162

163163
- You can have duplicate records for the same game where the UMU_ID for the game may be different across storefronts. The only time the umu ID will be the same is if a Steam version exists.
164164

165-
Example (no steam version):
165+
Example (non-Steam versions):
166166

167167
```\
168168
TITLE                   STORE    CODENAME                              UMU_ID                                 NOTE (Optional)
@@ -172,16 +172,15 @@ Genshin Impact          none     none               
172172

173173
- The protonfix for umu-7d690c122fde4c60bed85405f343ad10 should be a symbolic link to the protonfix for umu-genshin if they require the same fixes. They -can- be independent -IF- they require different fixes or if it's a new single title and no fix exists
174174

175-
Example (steam version):
175+
Example (game that is also sold on Steam):
176176

177177
```\
178178
TITLE                   STORE    CODENAME                              UMU_ID                                 NOTE (Optional)
179-
Red Dead Redemption 2   steam    none                                  umu-1174180
180179
Red Dead Redemption 2   egs      Heather                               umu-1174180
181180
Red Dead Redemption 2   none     none                                  umu-1174180                            standalone
182181
```
183182

184-
- The same applies here. Each different non-Steam version protonfix should be a symbolic link to the Steam version protonfix unless it requires different fixes.
183+
- The same applies here. Each different non-Steam version protonfix should be a symbolic link to the Steam version by its `UMU_ID` protonfix, unless it requires different fixes.
185184

186185
If no store and/or codename is specified it will search instead search the 'umu' gamefixes directory instead of the store directory for the umu ID.
187186

0 commit comments

Comments
 (0)