.\" 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" "5" "2024-11-13"
.PP
.SH NAME
.PP
umu-run - configuration file
.PP
.SH DESCRIPTION
.PP
umu-run can optionally read a configuration file instead of reading
environment variables set from the command line.\& The configuration file for
umu-run must be written in \fBTom'\&s Obvious Minimal Language (TOML)\fR[1].\&
.PP
In the configuration file, the table \fBumu\fR is required as well as the keys
\fBprefix\fR, \fBproton\fR and \fBexe\fR which all must be basic strings.\& e.\&g.\&:
.PP
.nf
.RS 4
[umu]
prefix = "~/WINE/epic-games-store"
exe = "~/EpicGamesLauncher\&.exe"
proton = "~/\&.local/share/Steam/compatibilitytools\&.d/GE-Proton30"
.fi
.RE
.PP
Afterwards, run the command:
.nf
.RS 4
$ umu-run --config config\&.toml
.fi
.RE
.PP
.SH [umu] SECTION
.PP
\fBexe\fR
.RS 4
Path to the game executable to run.\& Value must be a basic \fBstring\fR.\&
.PP
.RE
\fBproton\fR
.RS 4
Path to a Proton directory.\& Value must be a basic \fBstring\fR.\&
.PP
.RE
\fBprefix\fR
.RS 4
Path to a WINE prefix directory.\& Value must be a basic \fBstring\fR.\&
.PP
.RE
\fBgame_id\fR
.RS 4
The umu id to assign to the game.\& Depending on the value assigned, a proton
fix will be applied to the prefix if available.\& Please refer to the \fBumu
database\fR[2] for an extended list of game ids.\&
.PP
.RE
\fBstore\fR
.RS 4
The distribution platform of the executable.\& Value must be a basic \fBstring\fR.\&
Expects the values: egs, gog, battlenet, amazon, humble, itchio, and ubisoft.\&
.PP
.RE
\fBlaunch_args\fR
.RS 4
Launch arguments for the executable.\& Value must be a basic \fBstring\fR or an
\fBarray\fR of basic strings.\& When using a string, assumes each argument is
space-separated.\&
.PP
.RE
.SH NOTES
.PP
.PD 0
.IP 1. 4
https://toml.\&io/en/v1.\&0.\&0
.IP 2. 4
https://github.\&com/Open-Wine-Components/umu-database/blob/main/umu-database.\&csv
.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.\&