summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKurt Himebauch <136133082+xXJSONDeruloXx@users.noreply.github.com>2025-07-14 10:28:17 -0400
committerGitHub <noreply@github.com>2025-07-14 10:28:17 -0400
commit7a0fb1c68685e825204d28afac12b8d7dc013ab3 (patch)
tree184d29243420c700d6bff1f08ae19440d483c041
parent3b007d74cda29456fe142b59bf53912c8e8a7206 (diff)
parentb83ec780d0075edd1bb4eaeb8e60a1734ecac9b8 (diff)
downloaddecky-lsfg-vk-7a0fb1c68685e825204d28afac12b8d7dc013ab3.tar.gz
decky-lsfg-vk-7a0fb1c68685e825204d28afac12b8d7dc013ab3.zip
Merge pull request #11 from xXJSONDeruloXx/tooltip-copy
Tooltip copy & Readme Changes
-rw-r--r--README.md31
-rw-r--r--src/components/ConfigurationSection.tsx6
2 files changed, 11 insertions, 26 deletions
diff --git a/README.md b/README.md
index d8d8295..0f6d4da 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,14 @@
# Lossless Scaling for Steam Deck
-
-A demo & install tutorial is available here:
-
-<a href="https://www.youtube.com/watch?v=0KCXxhD-Y8s&embeds_referring_euri=https%3A%2F%2Fwww.reddit.com%2F&embeds_referring_origin=https%3A%2F%2Fwww.reddit.com&source_ve_path=MjM4NTE" target="_blank">
- <img src="https://img.youtube.com/vi/0KCXxhD-Y8s/0.jpg" alt="Demo & Install Tutorial" width="400"/>
-</a>
-
-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.
+**Unofficial Community Plugin**: This Decky Loader plugin is an independent project and is **not officially supported** by the creators of Lossless Scaling or lsfg-vk. Support is provided separately via the [Decky Lossless Discord Channel](https://discord.gg/SFhFy2Sd).
## 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.
+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 features on Linux with a controller friendly UI in SteamOS or Bazzite.
## Installation
-### Manual Installation (Current Method)
-**Note:** This plugin is not yet available on the Decky Plugin Store.
+**Note:** This plugin is not yet available on the Decky Plugin Store, it is in an experimental state, and likely to change drastically pending a full store release.
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
@@ -26,27 +18,20 @@ This plugin automates the installation of lsfg-vk, a compatibility layer that al
- 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. **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)
+3. **Click "Install lsfg-vk"** to automatically set up the lsfg-vk vulkan layer
+4. **Configure settings** using the plugin's UI.
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%`
+ - **Option 2**: Manual environment variables like `ENABLE_LSFG=1 LSFG_MULTIPLIER=2 %COMMAND%`
+ - See the [LSFG-VK WIKI](https://github.com/PancakeTAS/lsfg-vk/wiki/Configuring-lsfg%E2%80%90vk) for more information on each available environment variable
## Feedback and Support
-For per-game feedback and community support, check out the [Universal Blue Discord](https://discord.bazzite.gg/).
+For per-game feedback and community support, please join the [Decky Lossless Discord Channel](https://discord.gg/SFhFy2Sd)
## What it does
diff --git a/src/components/ConfigurationSection.tsx b/src/components/ConfigurationSection.tsx
index 707ad2a..ee18e5b 100644
--- a/src/components/ConfigurationSection.tsx
+++ b/src/components/ConfigurationSection.tsx
@@ -75,7 +75,7 @@ export function ConfigurationSection({
<PanelSectionRow>
<SliderField
label={`Flow Scale ${Math.round(config.flowScale * 100)}%`}
- description="Lowers the generated frame's resolution"
+ description="Lowers the internal motion estimation resolution"
value={config.flowScale}
min={0.25}
max={1.0}
@@ -96,7 +96,7 @@ export function ConfigurationSection({
<PanelSectionRow>
<ToggleField
label="Performance Mode"
- description="Use lighter model for FG (experimental)"
+ description="Use lighter model for FG"
checked={config.perfMode}
onChange={onPerfModeChange}
/>
@@ -105,7 +105,7 @@ export function ConfigurationSection({
<PanelSectionRow>
<ToggleField
label="Immediate Mode"
- description="Disable vsync for reduced input lag"
+ description="Reduce input lag (Experimental, will cause issues in many games)"
checked={config.immediateMode}
onChange={onImmediateModeChange}
/>