diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 16 insertions, 9 deletions
@@ -18,6 +18,8 @@ A Decky plugin that streamlines the installation of **lsfg-vk** ([Lossless Scaling Frame Generation Vulkan layer](https://github.com/PancakeTAS/lsfg-vk)) on Steam Deck, allowing you to use the Lossless Scaling frame generation features on Linux with a controller friendly UI in SteamOS, Bazzite, or any other Linux platform compatible with Decky Loader. +> The v2 layer payload is currently pinned to the owner-fork prerelease [`v2.0.0-decky.1`](https://github.com/xXJSONDeruloXx/lsfg-vk/releases/tag/v2.0.0-decky.1). + ## Installation 1. **Download the plugin** from the [releases tab](https://github.com/xXJSONDeruloXx/decky-lsfg-vk/releases) @@ -33,7 +35,7 @@ A Decky plugin that streamlines the installation of **lsfg-vk** ([Lossless Scali 1. **Purchase and install** [Lossless Scaling](https://store.steampowered.com/app/993090/Lossless_Scaling/) from Steam 2. **Open the plugin** from the Decky menu 3. **Click "Install lsfg-vk"** to automatically set up the lsfg-vk vulkan layer -4. **Configure settings** using the plugin's UI - adjust FPS multiplier, flow scale, performance mode, HDR settings, and experimental features +4. **Configure settings** using the plugin's UI - adjust FPS multiplier, flow scale, performance mode, FP16, automatic profile matching, and optional GPU selection 5. **Apply launch option** to games you want to use frame generation with: - Add `~/lsfg %command%` to your game's launch options in Steam Properties - Or use the "Launch Option Clipboard" button in the plugin to copy the command @@ -46,8 +48,12 @@ The plugin provides several configuration options to optimize frame generation f ### Core Settings - **FPS Multiplier**: Choose between 2x, 3x, or 4x frame generation - **Flow Scale**: Adjust motion estimation quality (lower = better performance, higher = better quality) -- **Performance Mode**: Uses a lighter processing model - recommended for most games -- **HDR Mode**: Enable for games that support HDR output +- **Performance Mode**: Uses a lighter processing model +- **Allow FP16**: Enable half-precision acceleration; disable it for older NVIDIA GPUs +- **Active In**: Optionally match a profile to executable names, Wine executables, or process names +- **Automatic Profile Matching**: Explicitly let lsfg-vk choose an `Active In` profile; otherwise the Decky-selected profile is always forced +- **GPU**: Optionally select the GPU by name, vendor/device ID, or PCI bus ID +- **Disable Frame Generation**: Disable the layer for the next launch without creating an invalid 1x profile ## Feedback and Support @@ -59,6 +65,7 @@ For per-game feedback and community support, please join the [decky-lsfg-vk Disc - Ensure you've added `~/lsfg %command%` to your game's launch options - Check that the Lossless Scaling DLL was detected correctly in the plugin - Try enabling Performance Mode if you're experiencing crashes +- Disable **Automatic Profile Matching** to force the profile selected in Decky, even when it has an `Active In` value - Make sure your game is running in fullscreen mode for best results **Performance issues?** @@ -70,17 +77,17 @@ For per-game feedback and community support, please join the [decky-lsfg-vk Disc ## What it does The plugin: -- Automatically downloads and installs the latest lsfg-vk Vulkan layer to `~/.local/lib/` -- Configures the Vulkan layer in `~/.local/share/vulkan/implicit_layer.d/` -- Creates a TOML configuration file in `~/.config/lsfg-vk/conf.toml` with your settings +- Downloads checksum-pinned x86_64 or Armada/aarch64 lsfg-vk v2 assets from the owner-fork release to `~/.local/lib/` +- Configures the v2 Vulkan layer in `~/.local/share/vulkan/implicit_layer.d/` +- Migrates the existing `~/.config/lsfg-vk/conf.toml` from v1 to v2 automatically on layer update, retaining a one-time `.v1.bak` backup - Automatically detects your Lossless Scaling DLL installation - Provides an easy-to-use interface to configure frame generation settings: - **FPS Multiplier**: Choose 2x, 3x, or 4x frame generation - **Flow Scale**: Adjust motion estimation quality vs performance - **Performance Mode**: Use lighter processing for better performance - - **HDR Mode**: Enable for HDR-compatible games - - **Experimental Features**: Override present mode and set FPS limits -- **Hot-reloading**: Configuration changes apply immediately without restarting games + - **FP16, Active In, GPU, and explicit automatic matching**: Use v2 profile parameters without ambiguous profile selection + - **Launch workarounds**: Preserve existing DXVK, Gamescope, Zink, MangoHud, and vkBasalt launch options +- **Hot-reloading**: Multiplier, flow scale, and performance-mode changes are reloaded while games run; other changes may require a swapchain recreation or restart - Easy uninstallation that removes all installed files when no longer needed ## Credits |