From 988271e7c2df75e66bbdcb7cbdcf8e3be5ff1159 Mon Sep 17 00:00:00 2001 From: Andrew Eikum Date: Mon, 8 Jul 2019 08:29:41 -0500 Subject: [PATCH] README: Clarify setting variable overrides --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad46464b..dd0ee5db 100644 --- a/README.md +++ b/README.md @@ -238,13 +238,17 @@ Runtime Config Options Proton can be tuned at runtime to help certain games run. The Steam client sets some options for known games using the STEAM_COMPAT_CONFIG variable. You can override these options using the environment variables described below. + The best way to set these environment overrides for all games is by renaming `user_settings.sample.py` to `user_settings.py` and modifying it appropriately. This file is located in the Proton installation directory in your Steam library -(often `~/.steam/steam/steamapps/common/Proton #.#`). If you want to change the -runtime configuration for a specific game, you can use the `Set Launch Options` -setting in the game's `Properties` dialog in the Steam client. You can launch -the game with environment variables using "`PROTON_VARIABLE=1 %command%`". +(often `~/.steam/steam/steamapps/common/Proton #.#`). + +If you want to change the runtime configuration for a specific game, you can +use the `Set Launch Options` setting in the game's `Properties` dialog in the +Steam client. Set the variable, followed by `%command%`. For example, input +"`PROTON_USE_WINED3D=1 %command%`" to use the OpenGL-based wined3d renderer +instead of the Vulkan-based DXVK renderer. To enable an option, set the variable to a non-0 value. To disable an option, set the variable to 0. To use Steam's default configuration, do