summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 720ed73..d0edb9c 100644
--- a/README.md
+++ b/README.md
@@ -13,13 +13,23 @@ This plugin automates the installation of lsfg-vk, a compatibility layer that al
2. **Purchase and install** [Lossless Scaling](https://store.steampowered.com/app/993090/Lossless_Scaling/) from Steam
3. **Open the plugin** from the Decky menu
4. **Click "Install lsfg-vk"** to automatically set up the compatibility layer
-5. **Apply launch commands** to the game you want to use frame generation with. The plugin provides a short guide for these commands in its interface.
+5. **Configure settings** using the plugin's UI controls:
+ - Enable/disable LSFG
+ - Set FPS multiplier (2-4)
+ - Adjust flow scale (0.25-1.0)
+ - Toggle HDR mode
+6. **Apply launch commands** to the game you want to use frame generation with:
+ - **Option 1 (Recommended)**: `~/lsfg && %COMMAND%` - Uses your plugin configuration
+ - **Option 2**: Manual environment variables like `ENABLE_LSFG=1 LSFG_MULTIPLIER=2 %COMMAND%`
## What it does
The plugin:
- Extracts the lsfg-vk library to `~/.local/lib/`
- Installs the Vulkan layer configuration to `~/.local/share/vulkan/implicit_layer.d/`
+- Creates an executable `lsfg` script in the home directory with configurable settings
+- Provides a user-friendly interface to configure LSFG settings (enable/disable, multiplier, flow scale, HDR)
+- Automatically updates the `lsfg` script when settings are changed
- Provides easy uninstallation by removing these files when no longer needed
## Credits