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
- Adds io shields such as the proton-ge Discord for support and Github release status to the project's header.
- Adds some additional sections such as Description and Contributing as well as project pages.
- Updates the format for texts to use code blocks for examples or file names, hyperlinking text to upstream projects instead of pasting raw urls, etc. whenever possible.
- Fixes grammar when appropriate such as always capitalizing Proton or Steam.
This is a unified launcher for windows games on linux. It is essentially a copy of the Steam Linux Runtime/Steam Runtime Tools (https://gitlab.steamos.cloud/steamrt/steam-runtime-tools) that Valve uses for proton, with some modifications made so that it can be used outside of Steam.
12
+
### What is this?
8
13
9
-
# What does it do?
14
+
This is a unified launcher for Windows games on Linux. It is essentially a copy of the [Steam Runtime Tools](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools) and [Steam Linux Runtime](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools/-/blob/main/docs/container-runtime.md) that Valve uses for [Proton](https://github.com/ValveSoftware/Proton), with some modifications made so that it can be used outside of Steam.
10
15
11
-
When steam launches a proton game, it launches it like this:
16
+
### What does it do?
17
+
18
+
When Steam launches a Proton game, it launches it like this:
12
19
13
20
```
14
21
/home/tcrider/.local/share/Steam/ubuntu12_32/reaper SteamLaunch AppId=348550 -- /home/tcrider/.local/share/Steam/ubuntu12_32/steam-launch-wrapper -- /home/tcrider/.local/share/Steam/steamapps/common/SteamLinuxRuntime_sniper/_v2-entry-point --verb=waitforexitandrun -- /home/tcrider/.local/share/Steam/compatibilitytools.d/GE-Proton8-27/proton waitforexitandrun /home/tcrider/.local/share/Steam/steamapps/common/Guilty Gear XX Accent Core Plus R/GGXXACPR_Win.exe
15
22
```
16
23
17
24
We can ignore this `/home/tcrider/.local/share/Steam/ubuntu12_32/steam-launch-wrapper`, it's just a process runner with no real value other than forwarding environment variables (more on that later).
18
25
19
-
I managed to pull the envvars it uses by making steam run printenv for the games command line. We needed these envvars because proton expects them in order to function. With them we can essentially make proton run without needing steam at all.
26
+
I managed to pull the environment variables it uses by making Steam run `printenv` for the game's command line. We needed these envvars because Proton expects them in order to function. With them we can essentially make Proton run without needing steam at all.
20
27
21
28
Next this part `/home/tcrider/.local/share/Steam/steamapps/common/SteamLinuxRuntime_sniper/_v2-entry-point`
22
29
23
-
The first part `/home/tcrider/.local/share/Steam/steamapps/common/SteamLinuxRuntime_sniper/` is steam-runtime-tools compiled https://gitlab.steamos.cloud/steamrt/steam-runtime-tools and is used alongside the sniper runtime container used during proton builds.
24
-
25
-
The second part `_v2-entry-point` is just a bash script which loads proton into the container and runs the game.
26
-
27
-
So, umu is basically a copy paste of SteamLinuxRuntime_sniper, which is a compiled version of steam-runtime-tools. We've renamed _v2-entry-point to umu and added `umu-run` to replace steam-launch-wrapper.
30
+
The first part `/home/tcrider/.local/share/Steam/steamapps/common/SteamLinuxRuntime_sniper/` is steam-runtime-tools compiled and is used alongside the sniper runtime container used during Proton builds.
28
31
29
-
When you use `umu-run` to run a game, it uses the specified WINEPREFIX, proton version, executable, and arguements passed to it to run the game in proton, inside steam's runtime container JUST like if you were running the game through Steam, except now you're no longer limited to Steam's game library or forced to add the game to Steam's library, in fact, you don't even have to have steam installed.
32
+
The second part `_v2-entry-point` is just a bash script which loads Proton into the container and runs the game.
30
33
31
-
# How do I use it?
34
+
So, umu is basically a copy paste of `SteamLinuxRuntime_sniper`, which is a compiled version of steam-runtime-tools. We've renamed `_v2-entry-point` to `umu` and added `umu-run` to replace `steam-launch-wrapper`.
32
35
33
-
Usage:
36
+
When you use `umu-run` to run a game, it uses the specified `WINEPREFIX`, Proton version, executable, and arguments passed to it to run the game in Proton, inside Steam's runtime container JUST like if you were running the game through Steam, except now you're no longer limited to Steam's game library or forced to add the game to Steam's library. In fact, you don't even have to have Steam installed.
See the [documentation](https://github.com/Open-Wine-Components/umu-launcher/blob/main/docs/umu.1.scd) for more examples and the [project's wiki](https://github.com/Open-Wine-Components/umu-launcher/wiki/Frequently-asked-questions-(FAQ)) for Frequently Asked Questions.
44
51
45
-
# What does this mean for other launchers (lutris/bottles/heroic/legendary,etc):
52
+
**Note**: umu-launcher will automatically use and download the latest Steam Runtime that is required by Proton, and move its files to `$HOME/.local/share/umu`.
46
53
47
-
- everyone can use + contribute to the same protonfixes, no more managing individual install scripts per launcher
48
-
- everyone can run their games through proton just like a native steam game
49
-
- no steam or steam binaries required
50
-
- a unified online database of game fixes (protonfixes)
54
+
### What does this mean for other launchers (Lutris, Bottles, Heroic, Legendary, etc.)?
51
55
52
-
right now protonfixes packages a folder of 'gamefixes' however it could likely be recoded to pull from online quite easily
56
+
- Everyone can use + contribute to the same protonfixes, no more managing individual install scripts per launcher
57
+
- Everyone can run their games through Proton just like a native Steam game
58
+
- No Steam or Steam binaries required
59
+
- A unified online database of game fixes (protonfixes)
53
60
54
-
The idea is to get all of these tools using this same `umu-run` and just feeding their envvars into it. That way any changes that need to happen can happen in proton-ge and/or protonfixes, or a 'unified proton' build based off GE, or whatever they want.
61
+
Right now protonfixes packages a folder of 'gamefixes' however it could likely be recoded to pull from online quite easily. The idea is to get all of these tools using this same `umu-run` and just feeding their envvars into it. That way any changes that need to happen can happen in proton-ge and/or protonfixes, or a 'unified proton' build based off GE, or whatever they want.
55
62
56
-
# What is the basic plan of putting this into action?
63
+
###What is the basic plan of putting this into action?
57
64
58
65
1. We build a database containing various game titles, their IDs from different stores, and their correlating umu ID.
59
-
2. Various launchers then search the database to pull the umu ID, and feed it as the game ID to umu-run alongside the store type, proton version, wine prefix, game executable, and launch arguements.
60
-
3. When the game gets launched from umu-run, protonfixes picks up the store type and umu ID and finds the appropriate fix script for it, then applies it before running the game.
66
+
2. Various launchers then search the database to pull the umu ID, and feed it as the game ID to `umu-run` alongside the store type, Proton version, wine prefix, game executable, and launch arguements.
67
+
3. When the game gets launched from `umu-run`, protonfixes picks up the store type and umu ID and finds the appropriate fix script for it, then applies it before running the game.
61
68
4. protonfixes has folders separated for each store type. The umu ID for a game remains the exact same across multiple stores, the only difference being it can have store specific scripts OR it can just symlink to another existing script that already has the fixes it needs.
62
69
63
70
Example:
64
71
65
72
Borderlands 3 from EGS store.
66
-
1. Generally a launcher is going to know which store it is using already, so that is easy enough to determine and feed the STORE variable to the launcher.
73
+
1. Generally a launcher is going to know which store it is using already, so that is easy enough to determine and feed the `STORE` variable to the launcher.
67
74
2. To determine the game title, EGS has various codenames such as 'Catnip'. The launcher would see "ok store is egs and codename is Catnip, let's search the umu database for those"
68
75
3. In our umu unified database, we create a 'title' column, 'store' column, 'codename' column, 'umu-ID' column. We add a line for Borderlands 3 and fill in the details for each column.
69
-
4. Now the launcher can search 'Catnip' and 'egs' as the codename and store in the database and correlate it with Borderlands 3 and umu-12345. It can then feed umu-12345 to the umu-run script.
76
+
4. Now the launcher can search 'Catnip' and 'egs' as the codename and store in the database and correlate it with Borderlands 3 and umu-12345. It can then feed umu-12345 to the `umu-run` script.
70
77
71
78
72
-
# Building and packaging:
73
-
Building umu currently requires `bash`, `make`,`meson` and `scdoc`
79
+
##Building
80
+
Building umu-launcher currently requires `bash`, `make`, and `scdoc`
74
81
75
-
To build umu, after downloading and extracting the source code from this repository, change into the newly extracted directory
82
+
To build umu-launcher, after downloading and extracting the source code from this repository, change into the newly extracted directory
76
83
```shell
77
84
cd umu-launcher
78
85
```
@@ -85,17 +92,17 @@ Change the `--prefix` as fit for your distribution, for example `/usr/local`, or
85
92
86
93
Then run `make` to build. After a successful build the resulting files should be available in the `./builddir` directory
87
94
88
-
## Installing
89
-
To install umu run the following command after completing the steps described above
95
+
###Installing
96
+
To install umu-launcher run the following command after completing the steps described above
90
97
```shell
91
98
make install
92
99
```
93
-
or if you are packaging umu
100
+
or if you are packaging umu-launcher
94
101
```shell
95
102
make DESTDIR=<packaging_directory> install
96
103
```
97
104
98
-
## Installing as user
105
+
###Installing as user
99
106
If you want to install umu just for your user, or for quickly testing, you can configure umu with the following command
100
107
```shell
101
108
./configure.sh --user-install
@@ -104,15 +111,24 @@ followed by
104
111
```shell
105
112
make install
106
113
```
107
-
This will install umu under `~/.local/share/umu` and place the executable in `~/.local/bin`
108
-
You will need to add `$HOME/.local/bin` in your `$PATH` to be able to run umu this way by exporting the path in your shell's configuration, for example `~/.bash_profile`
114
+
This will install umu-launcher under `$HOME/.local/share/umu` and place the executable in `$HOME/.local/bin`
115
+
You will need to add `$HOME/.local/bin` in your `$PATH` to be able to run umu-launcher this way by exporting the path in your shell's configuration, for example `$HOME/.bash_profile`
109
116
```shell
110
117
export PATH="$HOME/.local/bin:$PATH"
111
118
```
112
119
113
-
# Packages:
114
-
## NixOS
115
-
if you want to add umu-launcher as a flake add this to your inputs in flake.nix
120
+
## Packaging
121
+
122
+
### Nobara
123
+
```shell
124
+
dnf install -y umu-launcher*.rpm
125
+
```
126
+
127
+
### Arch Linux (AUR)
128
+
[](https://aur.archlinux.org/packages/umu-launcher)
129
+
130
+
### NixOS
131
+
If you want to add umu-launcher as a flake add this to your inputs in `flake.nix`
116
132
```nix
117
133
inputs = {
118
134
umu= {
@@ -121,91 +137,62 @@ if you want to add umu-launcher as a flake add this to your inputs in flake.nix
if there is any problem with the flake feel free to open a bug report and tag any of the maintainers
147
+
If there is any problem with the flake feel free to open a bug report and tag any of the maintainers
132
148
> maintainers: @beh-10257
133
149
134
-
# Usage notes:
135
-
136
-
When /usr/bin/umu-run is first run, it will copy the /usr/share/umu folder to ~/.local/share/umu. From that point on the ~/.local/share/umu folder will be used for running umu. It will also perform a version check to make sure that if the contents of /usr/share/umu are updated, that the local version also gets updated.
150
+
## Contributing
137
151
138
-
When /usr/bin/umu-run is first run, it also copies /usr/share/umu/umu-Runner to ~/.local/share/steam/compatibilitytools.d/ so that it can be used as a compatibility tool in steam for non-steam games the same way Proton is.
152
+
Contributions are welcome and appreciated. To get started, install [ruff](https://github.com/astral-sh/ruff) from your distribution and enable [ruff server](https://github.com/astral-sh/ruff/blob/main/crates/ruff_server/README.md)in your editor.
139
153
140
-
When /usr/bin/umu-run is run, if a PROTONPATH is not specified, it will automatically download and use umu-Proton and place it at ~/.local/share/steam/compatibilitytools.d/
141
-
142
-
When /usr/bin/umu-run is run, if a WINEPREFIX is not specified, it will automatically create one using the umu-id at ~/Games/umu/<umu-id>
143
-
144
-
# README notes from Valve's steam-runtime-tools:
154
+
# README notes from Valve's steam-runtime-tools
145
155
146
156
Steam Linux Runtime 3.0 (sniper)
147
157
================================
148
158
149
-
This container-based release of the Steam Runtime is used for native
150
-
Linux games, and for Proton 8.0+.
159
+
This container-based release of the Steam Runtime is used for native Linux games, and for Proton 8.0+.
See [container-runtime](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools/-/blob/main/docs/container-runtime.md) for details and the [steamrt wiki](https://gitlab.steamos.cloud/steamrt/steamrt/-/wikis/home) for a list of container-based runtimes.
The runtime's behaviour can be changed by running the Steam client with
179
-
environment variables set.
181
+
The runtime's behaviour can be changed by running the Steam client with environment variables set.
180
182
181
-
`STEAM_LINUX_RUNTIME_LOG=1` will enable logging. Log files appear in
182
-
`SteamLinuxRuntime_sniper/var/slr-*.log`, with filenames containing the app ID.
183
-
`slr-latest.log` is a symbolic link to whichever one was created most
184
-
recently.
183
+
`STEAM_LINUX_RUNTIME_LOG=1` will enable logging. Log files appear in `SteamLinuxRuntime_sniper/var/slr-*.log`, with filenames containing the app ID. `slr-latest.log` is a symbolic link to whichever one was created most recently.
185
184
186
-
`STEAM_LINUX_RUNTIME_VERBOSE=1` produces more detailed log output,
187
-
either to a log file (if `STEAM_LINUX_RUNTIME_LOG=1` is also used) or to
188
-
the same place as `steam` output (otherwise).
185
+
`STEAM_LINUX_RUNTIME_VERBOSE=1` produces more detailed log output, either to a log file (if `STEAM_LINUX_RUNTIME_LOG=1` is also used) or to the same place as `steam` output (otherwise).
189
186
190
-
`PRESSURE_VESSEL_SHELL=instead` runs an interactive shell in the
191
-
container instead of running the game.
187
+
`PRESSURE_VESSEL_SHELL=instead` runs an interactive shell in the container instead of running the game.
for details of assumptions made about the host operating system, and some
196
-
advice on debugging the container runtime on new Linux distributions.
189
+
Please see [distribution assumptions](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools/-/blob/main/docs/distro-assumptions.md) for details of assumptions made about the host operating system, and some advice on debugging the container runtime on new Linux distributions.
197
190
198
-
Game developers who are interested in targeting this environment should
199
-
check the SDK documentation <https://gitlab.steamos.cloud/steamrt/sniper/sdk>
Game developers who are interested in targeting this environment should check the [SDK documentation](https://gitlab.steamos.cloud/steamrt/sniper/sdk) and [general information for game developers](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools/-/blob/main/docs/slr-for-game-developers.md).
202
192
203
193
Licensing and copyright
204
-
-----------------------
194
+
--------------
205
195
206
-
The Steam Runtime contains many third-party software packages under
207
-
various open-source licenses.
196
+
The Steam Runtime contains many third-party software packages under various open-source licenses.
208
197
209
-
For full source code, please see the version-numbered subdirectory of
corresponding to the version numbers listed in VERSIONS.txt.
198
+
For full source code, please see the [version-numbered subdirectory](https://repo.steampowered.com/steamrt-images-sniper/snapshots) corresponding to the version numbers listed in `VERSIONS.txt`.
0 commit comments