From cd99923b5eae1ec31a876168ca22cdcc613230d1 Mon Sep 17 00:00:00 2001 From: Andrew Eikum Date: Wed, 28 Mar 2018 10:36:55 -0500 Subject: [PATCH] README: Document runtime options --- README | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README b/README index 859f24be..94e2bef0 100644 --- a/README +++ b/README @@ -29,3 +29,27 @@ NOTE: For now, dxvk requires build-time components that are too new for Debian 9. It's recommended to build the DLLs on Arch Linux, where dxvk is actively being developed. This may be resolved in dxvk in the future, or may be worked around by using a newer Debian release. See comments in build_proton.sh. + + +---- +RUNTIME CONFIG OPTIONS +---- + +Proton can be tuned at runtime to help certain games run. The runtime +configuration options are documented here. Options can either be defined in a +comma-separated list stored in the STEAM_COMPAT_CONFIG environment variable +when running Proton (the Steam client does this), or passed through the +presence of individual environment variables as documented below. + +All of the below are runtime options. They do not effect permanent changes to +the Wine prefix. Removing the option will revert to the previous behavior. + +---- +Run game with DXVK instead of wined3d. +Compat config string: dxvk +Environment variable: PROTON_USE_DXVK + +---- +Disable d3d11.dll, for games which can fall back to and run better with d3d9. +Compat config string: nod3d11 +Environment variable: PROTON_NO_D3D11