.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "umu" "1" "2024-11-13"
.PP
.SH NAME
.PP
umu-run - Unified Launcher for Windows Games on Linux
.PP
.SH SYNOPSIS
.PP
\fBumu-run\fR [\fIFILE\fR]
.PP
\fBumu-run\fR [\fIFILE\fR [\fIARG\fR.\&.\&.\&]]
.PP
\fBumu-run\fR [\fIwinetricks\fR [\fIARG\fR.\&.\&.\&]]
.PP
\fBumu-run\fR \fB--config\fR [\fIFILE\fR]
.PP
\fBumu-run\fR \fB--help\fR
.PP
.SH POSITIONAL ARGUMENTS
.PP
\fBwinetricks\fR
.RS 4
Run \fBwinetricks\fR[1] verbs (Requires GE-Proton or UMU-Proton).\&
.PP
See \fBwinetricks\fR(1) for more info or below for an example.\&
.PP
.RE
.SH OPTIONS
.PP
\fB-h, --help\fR
.RS 4
Show this help message.\&
.PP
.RE
\fB--config\fR <config>
.RS 4
Path to TOML configuration file (Requires Python 3.\&11+).\&
.PP
See \fBumu\fR(5) for more info and examples.\&
.PP
.RE
.SH DESCRIPTION
.PP
The Unified Launcher for Windows Games on Linux (umu) was created to make
Valve'\&s \fBProton\fR[2] and the \fBprotonfixes\fR[3] project accessible outside the
Steam client, providing a standardized way for other clients (e.\&g.\&, Lutris,
Heroic Games Launcher, Bottles, or Rare) to run games via Proton and configure
WINE prefixes.\&
.PP
As a result, clients:
.PD 0
.IP \(bu 4
No longer require Steam or Steam binaries to be installed
.IP \(bu 4
Can contribute and automatically benefit from protonfixes
.IP \(bu 4
Can run games through Proton as it were a native Steam game
.IP \(bu 4
Can reference a unified online database of game fixes (protonfixes)
.PD
.PP
You can run umu directly from a terminal emulator, or through your launcher of 
choice if supported.\&
.PP
.SH EXAMPLES
.PP
\fBExample 1.\& Run a game\fR
.PP
.nf
.RS 4
$ WINEPREFIX=~/\&.wine GAMEID=0 PROTONPATH=~/GE-Proton9-4 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 2.\& Run a game and apply a specific protonfix\fR
.PP
.nf
.RS 4
# Applies the Star Citizen fix to the current WINE prefix
$ WINEPREFIX=~/\&.wine GAMEID=umu-starcitizen PROTONPATH=~/GE-Proton9-4 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 3.\& Run a game via a configuration file\fR
.PP
.nf
.RS 4
# config\&.toml
[umu]
prefix = "~/\&.wine"
proton = "~/GE-Proton30"
game_id = "0"
exe = "~/foo\&.exe"
launch_args = ["-opengl", "-SkipBuildPatchPrereq"]
store = "gog"
$ umu-run --config config\&.toml
.fi
.RE
.PP
\fBExample 4.\& Create a umu WINE prefix\fR
.PP
.nf
.RS 4
$ WINEPREFIX=~/foo GAMEID=0 PROTONPATH=~/GE-Proton9-4 umu-run ""
.fi
.RE
.PP
\fBExample 5.\& Run a game and automatically set Proton\fR
.PP
.nf
.RS 4
# Uses the latest UMU-Proton and automatically removes old UMU-Proton builds
$ WINEPREFIX=~/\&.wine GAMEID=0 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 6.\& Run a game, automatically set Proton, and create a WINE prefix\fR
.PP
.nf
.RS 4
# Creates the prefix as $HOME/Games/umu/$GAMEID and uses the latest UMU-Proton
$ GAMEID=0 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 7.\& Run a game and explicitly set a valid Proton verb\fR
.PP
.nf
.RS 4
$ WINEPREFIX=~/\&.wine GAMEID=0 PROTONPATH=~/GE-Proton9-4 PROTON_VERB=waitforexitandrun umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 8.\& Run a game and enable debug logs\fR
.PP
.nf
.RS 4
$ UMU_LOG=debug WINEPREFIX=~/\&.wine GAMEID=0 PROTONPATH=~/GE-Proton9-4 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 9.\& Run a game and set a Proton by its version name\fR
.PP
.nf
.RS 4
# Checks for GE-Proton9-1 at $HOME/\&.local/share/Steam/compatibilitytools\&.d
$ WINEPREFIX=~/\&.wine GAMEID=0 PROTONPATH=GE-Proton9-1 umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 10.\& Run a game and automatically use the latest GE-Proton\fR
.PP
.nf
.RS 4
$ WINEPREFIX=~/\&.wine GAMEID=0 PROTONPATH=GE-Proton umu-run foo\&.exe
.fi
.RE
.PP
\fBExample 11.\& Run winetricks verbs\fR
.PP
.nf
.RS 4
$ GAMEID=0 PROTONPATH=GE-Proton umu-run winetricks quartz wmp11 qasf
.fi
.RE
.PP
\fBExample 12.\& Run a game, but do not apply protonfixes\fR
.PP
.nf
.RS 4
$ GAMEID=umu-1228964594 PROTONPATH=GE-Proton PROTONFIXES_DISABLE=1 umu-run foo\&.exe
.fi
.RE
.PP
.SH ENVIRONMENT VARIABLES
.PP
\fIGAMEID\fR
.RS 4
Required.\& Can be an arbitrary value or a valid id in the \fBumu-database\fR[4].\&
.PP
.RE
\fIPROTONPATH\fR
.RS 4
Optional.\& Path to a Proton directory, version name (e.\&g.\&, GE-Proton9-5) or codename (e.\&g.\&, GE-Proton).\&
.PP
Otherwise, defaults to using UMU-Proton.\&
.PP
.RE
\fIWINEPREFIX\fR
.RS 4
Optional.\& Path to a WINE prefix directory.\& Otherwise defaults to \fI$HOME/Games/umu/$GAMEID\fR.\&
.PP
.RE
\fIUMU_LOG\fR
.RS 4
Optional.\& Enables debug logs for the launcher.\&
.PP
.PP
Set \fI1\fR to log environment variables, \fIwarning\fR for warning messages, or \fIdebug\fR to enable all logs.\&
.PP
.RE
\fISTORE\fR
.RS 4
Optional.\& Can be an arbitrary value or a valid store id in the umu-database.\&
.PP
.RE
\fIPROTON_VERB\fR
.RS 4
Optional.\& Must be a valid Proton verb.\& Otherwise, defaults to \fIwaitforexitandrun\fR.\&
.PP
.RE
\fIUMU_ZENITY\fR
.RS 4
Optional.\& Creates a \fBzenity\fR[5] popup window when downloading large files.\&
.PP
.RE
\fIUMU_RUNTIME_UPDATE\fR
.RS 4
Optional.\& Disables automatic updates to the \fBSteam Linux Runtime\fR[6].\&
.PP
Set \fI0\fR to disable updates.\&
.PP
.RE
\fIUMU_NO_PROTON\fR
.RS 4
Optional.\& Runs the executable natively within the Steam Linux Runtime.\& Intended for native Linux games.\&
.PP
Set \fI1\fR to run the executable natively within the SLR.\&
.PP
.RE
.SH SEE ALSO
.PP
\fIumu\fR(5), \fIwinetricks\fR(1), \fIzenity\fR(1)
.PP
.SH NOTES
.PP
.PD 0
.IP 1. 4
https://github.\&com/Winetricks/winetricks
.IP 2. 4
https://github.\&com/ValveSoftware/Proton
.IP 3. 4
https://github.\&com/Open-Wine-Components/umu-protonfixes
.IP 4. 4
https://github.\&com/Open-Wine-Components/umu-database
.IP 5. 4
https://gitlab.\&gnome.\&org/GNOME/zenity
.IP 6. 4
https://gitlab.\&steamos.\&cloud/steamrt/steam-runtime-tools/-/blob/main/docs/container-runtime.\&md
.PD
.PP
.SH AUTHORS
.PP
Maintained by Open Wine Components members, and assisted by other open source
contributors.\& For more information about umu development, see
https://github.\&com/Open-Wine-Components/umu-launcher.\&