Skip to content
Snippets Groups Projects
Commit 6b9b6c26 authored by Simon McVittie's avatar Simon McVittie
Browse files

pv-wrap(1): Document STEAM_COMPAT_RUNTIME_SDL2, etc.


Followup from steamrt/tasks#578

Signed-off-by: default avatarSimon McVittie <smcv@collabora.com>
parent f21aab3e
No related branches found
No related tags found
No related merge requests found
...@@ -444,6 +444,12 @@ The following environment variables (among others) are read by ...@@ -444,6 +444,12 @@ The following environment variables (among others) are read by
variable data directory used by Proton, if any. variable data directory used by Proton, if any.
This is made available read/write in the container. This is made available read/write in the container.
`STEAM_COMPAT_FLAGS` (comma-separated list of tokens)
: `runtime-sdl2` is equivalent to `STEAM_COMPAT_RUNTIME_SDL2=1`.
`runtime-sdl3` is equivalent to `STEAM_COMPAT_RUNTIME_SDL3=1`.
Other tokens are ignored by pressure-vessel-wrap, but might
have an effect on other components.
`STEAM_COMPAT_INSTALL_PATH` (path) `STEAM_COMPAT_INSTALL_PATH` (path)
: Top-level directory containing the game itself, even if the current : Top-level directory containing the game itself, even if the current
working directory is actually a subdirectory of this. working directory is actually a subdirectory of this.
...@@ -462,6 +468,21 @@ The following environment variables (among others) are read by ...@@ -462,6 +468,21 @@ The following environment variables (among others) are read by
: Colon-delimited list of paths to additional directories that are to : Colon-delimited list of paths to additional directories that are to
be made available read/write in the container. be made available read/write in the container.
`STEAM_COMPAT_RUNTIME_SDL2` (boolean)
: If set to `1`, set `SDL_DYNAMIC_API` so that the runtime's version
of SDL 2 will be used in preference to any copy that might be bundled
or statically linked in an app or game (as long as it is version ≥ 2.0.2
and the `dynapi` feature has not been disabled).
The advantage of this variable over setting `SDL_DYNAMIC_API` directly
is that pressure-vessel-wrap sets up appropriate distribution-specific
paths so that both 32- and 64-bit SDL 2 will work.
Typically this would be enabled by setting a game's Steam launch
options to `STEAM_COMPAT_RUNTIME_SDL2=1 %command%`.
`STEAM_COMPAT_RUNTIME_SDL3` (boolean)
: Same as `STEAM_COMPAT_RUNTIME_SDL2`, but setting `SDL3_DYNAMIC_API`
for SDL 3 apps or games.
`STEAM_COMPAT_SESSION_ID` (integer) `STEAM_COMPAT_SESSION_ID` (integer)
: (Not used yet, but should be.) : (Not used yet, but should be.)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment