summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxXJSONDeruloXx <danielhimebauch@gmail.com>2025-07-13 13:24:30 -0400
committerxXJSONDeruloXx <danielhimebauch@gmail.com>2025-07-13 13:24:30 -0400
commit83a528be3a23bd43beb6a002c023a3673cad03ae (patch)
tree48864efe2d74271e2e3688cb31ecf7742f1a8844 /README.md
parent7866a9a77d2a0922883637576f6cdac122c56d42 (diff)
downloaddecky-lsfg-vk-83a528be3a23bd43beb6a002c023a3673cad03ae.tar.gz
decky-lsfg-vk-83a528be3a23bd43beb6a002c023a3673cad03ae.zip
update readme w manual install instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 25 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4420715..7dc2ee1 100644
--- a/README.md
+++ b/README.md
@@ -8,22 +8,41 @@ This plugin automates the installation of lsfg-vk, a compatibility layer that al
<img width="581" height="893" alt="image" src="https://github.com/user-attachments/assets/23931a7f-b496-4d41-bde4-3dfbb4ba7d4b" />
+## Installation
+
+### Manual Installation (Current Method)
+**Note:** This plugin is not yet available on the Decky Plugin Store.
+
+1. **Download the plugin** from the [latest release](https://github.com/xXJSONDeruloXx/decky-lossless-scaling-vk/releases/tag/Latest)
+ - Download the "Lossless Scaling.zip" file to your Steam Deck
+2. **Install manually through Decky**:
+ - In Game Mode, go to the settings cog in the top right of the Decky Loader tab
+ - Enable "Developer Mode"
+ - Go to "Developer" tab and select "Install Plugin from Zip"
+ - Select the downloaded "Lossless Scaling.zip" file
+
+### Future Installation
+- This plugin will be available through the Decky Plugin Store once approved
+
## 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:
+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 compatibility layer
+4. **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:
+5. **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%`
+## Feedback and Support
+
+For per-game feedback and community support, check out the [Lossless Scaling Discord](https://discord.gg/losslessscaling).
+
## What it does
The plugin: