thirdpartymirrors/lsfg-vk
1
0
Fork 0
mirror of https://github.com/PancakeTAS/lsfg-vk.git synced 2026-07-10 16:51:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve README wording and clarity

Browse source 
Improve phrasing, consistency, and readability throughout
README.md. This also clarifies some installation and configuration instructions and corrects a few minor inaccuracies.
This commit is contained in:
Felt389 2026-05-19 20:53:30 +02:00 • committed by GitHub
parent 218820e8dc
commit 60663dfaf1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,5 +1,5 @@
# lsfg-vk
**Lossless Scaling** is a Windows-exclusive program featuring various algorithms for scaling and interpolating programs.
**Lossless Scaling** is a Windows-only program that features various algorithms for scaling and interpolating programs.
**lsfg-vk** is a Vulkan layer that hooks into Vulkan applications and generates additional frames using Lossless Scaling's frame generation algorithm.
@ -8,18 +8,18 @@
## Installation
>[!TIP]
> If you are on a Steam Deck or similar handheld, consider using the [Decky plugin for lsfg-vk](https://github.com/xXJSONDeruloXx/decky-lsfg-vk). This is an easy way to install and configure lsfg-vk on the Steam Deck.
> Please keep in mind that it is not officially supported and support questions should be directed to the plugin's repository & discord.
> If you are on a Steam Deck or similar handheld device, consider using the [Decky plugin for lsfg-vk](https://github.com/xXJSONDeruloXx/decky-lsfg-vk). This is an easy way to install and configure lsfg-vk on the Steam Deck.
> Please keep in mind that this is not officially supported and support queries should be directed to the plugin's repository and Discord server.
1. Before proceeding, please make sure you have [Lossless Scaling](https://store.steampowered.com/app/993090/Lossless_Scaling/) downloaded on Steam.
2. Head to the [GitHub Releases](https://github.com/PancakeTAS/lsfg-vk/releases) and download the file named "lsfg-vk-2.0.0-x86_64.tar.xz".
3. Open a terminal in the folder where you downloaded the file and run the following:
1. Before proceeding, please make sure you have [Lossless Scaling](https://store.steampowered.com/app/993090/Lossless_Scaling/) installed on Steam.
2. Head to the [GitHub Releases](https://github.com/PancakeTAS/lsfg-vk/releases) page and download the file named "lsfg-vk-2.0.0-x86_64.tar.xz".
3. Open a terminal in the folder where you downloaded the file and run the following command:
```bash
tar -xvf lsfg-vk-2.0.0-linux.tar.xz -C ~/.local
tar -xvf lsfg-vk-2.0.0-x86_64.tar.xz -C ~/.local
```
This will extract lsfg-vk to `~/.local`. Please **keep track of the files that were extracted**, in case you want to uninstall lsfg-vk later.
This will extract lsfg-vk to the `~/.local` folder. Please **keep track of the files that were extracted**, in case you wish to uninstall lsfg-vk later.
4. The graphical interface requires Qt6 and Qt6 Quick in order to run. If you do not have these installed, install the following packages:
4. The graphical interface of lsfg-vk requires Qt6 and Qt6 Quick in order to run. If you do not have these installed, install the following packages:
```bash
sudo apt install qt6-qpa-plugins libqt6quick6 qml6-module-qtquick-controls qml6-module-qtquick-layouts qml6-module-qtquick-window qml6-module-qtquick-dialogs qml6-module-qtqml-workerscript qml6-module-qtquick-templates qml6-module-qt-labs-folderlistmodel # On Debian/Ubuntu-based systems
sudo pacman -S qt6-declarative qt6-base # On Arch-based systems
@ -29,27 +29,27 @@ sudo dnf install qt6-qtdeclarative qt6-qtbase # On Fedora
5. (Optional) If you wish to use lsfg-vk within Flatpak applications, see the [Flatpak Guide](docs/Flatpak-Guide.md).
## Usage
In order to start using lsfg-vk, you will need to configure it. This can either be done using the GUI application, or manually.
In order to use lsfg-vk, you will need to configure it. This can be done using the included GUI application, or by manually editing the configuration.
### Graphical Configuration
Start 'lsfg-vk Configuration Window' from your application launcher, or run `~/.local/bin/lsfg-vk-ui` in a terminal:
- On the left side, you will see a list of profiles. Each profile has its own settings.
- All properties in the "Global Settings" section apply to all profiles.
- Should Lossless Scaling be installed in a non-standard location, you can specify the path here.
- Should Lossless Scaling be installed in a non-standard location, you can specify its path here.
- Select a profile and configure the "Profile Settings" section to your liking.
- When editing the "Active In" list, you can add a game using its executable name (e.g. `Game.exe`, `mpv`).
- Please see the [documentation](docs/Configuration.md) for detailed information on each setting.
- Once you are done configuring, simply starting a game that matches one of the profiles will automatically apply the settings.
- When editing the "Active In" list, you can add a program using the name of its executable (e.g., `Game.exe`, `mpv`).
- Please see the [documentation](docs/Configuration.md) for detailed information about each setting.
- Once you are done configuring, starting a program that matches one of your profiles will automatically apply your settings.
### Manual Configuration
The default configuration is located in `~/.config/lsfg-vk/conf.toml`. It will be created automatically when any Vulkan application is started.
- In the `[global]` section, you can change where Lossless Scaling is installed, as well as other global settings.
The default configuration is located in `~/.config/lsfg-vk/conf.toml`. It will be created automatically when any Vulkan application is started with lsfg-vk.
- In the `[global]` section, you can specify where Lossless Scaling is installed, as well as other global settings.
- Each profile is defined in its own `[[profile]]` section.
- The `active_in` array/string defines which applications the profile is active in. You can add applications using their executable name (e.g. `Game.exe`, `mpv`).
- Please see the [documentation](docs/Configuration.md) for detailed information on each setting.
- Once you are done configuring, simply starting a game that matches one of the profiles will automatically apply the settings.
- The `active_in` array/string defines which programs the profile applies to. You can add programs using the name of their executable (e.g., `Game.exe`, `mpv`).
- Please see the [documentation](docs/Configuration.md) for detailed information about each setting.
- Once you are done configuring, starting a program that matches one of your profiles will automatically apply your settings.
You can validate the configuration using `lsfg-vk-cli`:
You can validate your configuration using `lsfg-vk-cli`:
```bash
~/.local/bin/lsfg-vk-cli validate
```
@ -60,7 +60,7 @@ You can run a frame generation benchmark using `lsfg-vk-cli`:
~/.local/bin/lsfg-vk-cli benchmark
```
By default, the benchmark will run for 10 seconds. Add `-h` to see all available benchmarking options.
By default, the benchmark will run for 10 seconds. Add `-h` to the command to see all available benchmarking options.
## Support and Troubleshooting
If you encounter any issues or have questions regarding lsfg-vk, read through the [Troubleshooting](docs/Troubleshooting.md) documentation page or join the [Discord server](https://discord.gg/losslessscaling) for assistance.
If you encounter issues or have any questions regarding lsfg-vk, please see the [Troubleshooting](docs/Troubleshooting.md) documentation page, or join the [Discord server](https://discord.gg/losslessscaling) for further support.