Skip to content

Commit

Permalink
Update documentation (#59)
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
R1kaB3rN authored Mar 10, 2024
1 parent 825d416 commit 15fd75b
Showing 1 changed file with 43 additions and 19 deletions.
62 changes: 43 additions & 19 deletions docs/ulwgl.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,50 @@ ulwgl-run - Unified Launcher for Windows Games on Linux
# OPTIONS

*-h, --help*
Show this help message
Show this help message.

*--config* <config>
Path to TOML configuration file (Requires Python 3.11+)
Path to TOML configuration file (Requires Python 3.11+).

See *ulwgl*(5) for more info and examples
See *ulwgl*(5) for more info and examples.

# DESCRIPTION

The Unified Launcher for Windows Games on Linux (ULWGL) was created to make
Valve's Proton and the Protonfixes 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.

As a result, clients:
- No longer require Steam or Steam binaries to be installed
- Can contribute and benefit from Protonfixes
- Can run games through Proton as it were a native Steam game
- Can reference a unified online database of game fixes (Protonfixes)

You can run ULWGL directly from a terminal emulator, or through your launcher of
choice if supported.

# EXAMPLES

*Example 1. Run a game*

```
# Play a game
$ WINEPREFIX= GAMEID=0 PROTONPATH= ulwgl-run ~/foo.exe
```

*Example 2. Run a game and apply a Protonfix*

```
# Play a game and apply a GOG Protonfix
# Can be a Steam or non-Steam game
# Applies a GOG Protonfix to the current WINE prefix
# See https://github.com/Open-Wine-Components/ULWGL-protonfixes
$ WINEPREFIX= GAMEID=ulwgl-1228964594 PROTONPATH= STORE=gog ulwgl-run ~/foo.exe
```

*Example 3. Run a game via a configuration file*

```
# Play a non-Steam game by reading a configuration file
# config.toml
[ulwgl]
prefix = "~/.wine"
proton = "~/GE-Proton30"
Expand All @@ -43,37 +65,39 @@ store = "gog"
$ ulwgl-run --config config.toml
```

*Example 4. Create a ULWGL WINE prefix*

```
# Create a ULWGL WINE prefix
$ WINEPREFIX=~/foo GAMEID=0 PROTONPATH= ulwgl-run ""
```

```
# Play a game and download the latest ULWGL-Proton
$ WINEPREFIX= GAMEID=0 ulwgl-run foo.exe
```
*Example 5. Run a game and automatically set Proton*

```
# Play a game and automatically set Proton
# Will first search ~/.local/share/Steam/compatibilitytools.d for latest
# When a Proton cannot be found, ULWGL-Proton will be downloaded
# First checks for a recent Proton at ~/.local/share/Steam/compatibilitytools.d
# When Proton cannot be found, the latest ULWGL-Proton will be downloaded
# The cache ~/.cache/ULWGL will be checked if the download fails or interrupted
$ WINEPREFIX= GAMEID=0 ulwgl-run foo.exe
```

*Example 6. Run a game, automatically set Proton, and create a WINE prefix*

```
# Play a game, automatically set Proton and create a prefix
# This will create the prefix as ~/Games/ULWGL/<ulwgl-$GAMEID>
$ GAMEID=0 ulwgl-run foo.exe
```

*Example 7. Run a game and explicitly set a valid Proton verb*

```
# Play a game and explicitly set a valid Proton verb
$ WINEPREFIX= GAMEID=0 PROTONPATH= PROTON_VERB=waitforexitandrun ulwgl-run ~/foo.exe
```

*Example 8. Run a game and enable debug logs*

```
# Play a game and enable debug logs
# Valid values include: 1, warn, debug
# Shows environment variables and command at this level
# Valid values for ULWGL_LOG include: 1, warn, debug
$ ULWGL_LOG=1 WINEPREFIX= GAMEID=0 PROTONPATH= ulwgl-run ~/foo.exe
```

Expand Down

0 comments on commit 15fd75b

Please sign in to comment.