From 83a528be3a23bd43beb6a002c023a3673cad03ae Mon Sep 17 00:00:00 2001 From: xXJSONDeruloXx Date: Sun, 13 Jul 2025 13:24:30 -0400 Subject: update readme w manual install instructions --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) (limited to 'README.md') 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 image +## 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: -- cgit v1.2.3