Skip to content

Commit

Permalink
docs: add doc for config
Browse files Browse the repository at this point in the history
  • Loading branch information
R1kaB3rN committed Mar 7, 2024
1 parent 0121186 commit 099a94d
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/ulwgl.5.scd
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
ulwgl(5)

# NAME

ulwgl-run - configuration file

# DESCRIPTION

ulwgl-run can optionally read a configuration file instead of reading
environment variables set from the command line. The configuration file for
ulwgl-run must be written in valid Tom's Obvious Minimal Language (TOML).

In the configuration file, the table *ulwgl* is required as well as the keys
*prefix*, *proton* and *exe* which all must be basic strings. e.g.:

```
[ulwgl]
prefix = "~/WINE/epic-games-store"
exe = "~/EpicGamesLauncher.exe"
proton = "~/.local/share/Steam/compatibilitytools.d/GE-Proton30"
```

Afterwards, run the command:
```
$ ulwgl-run --config config.toml
```

# [ulwgl] SECTION

*exe*
Path to the game executable to run. Value must be a basic *string*.

*proton*
Path to a Proton directory. Value must be a basic *string*.

*prefix*
Path to a WINE prefix directory. Value must be a basic *string*.

*game_id*
The ULWGL 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 ULWGL
database for an extended list of game ids.

*store*
The distribution platform of the executable. Value must be a basic *string*.
Expects the values: egs, gog, battlenet, amazon, humble, itchio, and ubisoft.

*launch_args*
Launch arguments for the executable. Value must be a basic *string*.
Assumes each argument is space-separated.

# AUTHORS

Maintained by Open Wine Components members, and assisted by other open source
contributors. For more information about ULWGL development, see
https://github.com/Open-Wine-Components/ULWGL-launcher.

0 comments on commit 099a94d

Please sign in to comment.