README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# Lossless Scaling for Steam Deck
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 app on Linux.

## What is this?

This plugin automates the installation of lsfg-vk, a compatibility layer that allows the Windows-only [Lossless Scaling](https://store.steampowered.com/app/993090/Lossless_Scaling/) app to work on Linux systems like Steam Deck. Lossless Scaling provides frame generation and upscaling features for games.

![Plugin Screenshot](assets/image.png)

## How to Use

1. **Install the plugin** through the Decky Plugin Store (TBD)
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. **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
   - Toggle immediate mode (disable vsync)
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, immediate mode)
- Automatically updates the `lsfg` script when settings are changed
- Provides easy uninstallation by removing these files when no longer needed

## Credits

[PancakeTAS](https://github.com/PancakeTAS/lsfg-vk) for creating the lsfg-vk compatibility layer.