module.nix: deprecate losslessDLLFile option

This commit is contained in:
Nojus 2025-07-18 21:39:14 +02:00
parent 955774220f
commit 51fc478dae
2 changed files with 14 additions and 15 deletions

View file

@ -3,7 +3,7 @@ Nix flake for using [Lossless Scaling's frame generation on Linux](https://githu
>[!IMPORTANT]
> You need to have Lossless Scaling installed on Steam!
> In case it is not installed on the default Steam drive, you may want to consider setting the environment variable ``LSFG_DLL_PATH=<ABSOLUTE_PATH_TO>/Lossless.dll``
> In case it is not installed on the default Steam drive, you may want to consider setting the correct path in the lsfg-vk config.
## Installation
### System-wide (NixOS module)
@ -31,11 +31,7 @@ outputs = {nixpkgs, lsfg-vk-flake, ...}: {
And then you should be able to enable this in your system config using:
```nix
services.lsfg-vk = {
enable = true;
# optional but recommended:
losslessDLLFile = "<ABSOLUTE_PATH_TO>/Lossless.dll";
};
services.lsfg-vk.enable = true;
```
### User install (manual)

View file

@ -19,15 +19,18 @@ in
default = lsfg-vk;
};
losslessDLLFile = lib.mkOption {
type = with lib.types; nullOr str;
default = null;
example = "/home/user/games/Lossless Scaling/Lossless.dll";
description = ''
Sets the LSFG_DLL_PATH environment variable.
Required if Lossless Scaling isn't installed in a standard location
'';
};
losslessDLLFile =
lib.warn "losslessDLLFile is deprecated and will only be used by lsfg-vk if LSFG_LEGACY is set."
lib.mkOption
{
type = with lib.types; nullOr str;
default = null;
example = "/home/user/games/Lossless Scaling/Lossless.dll";
description = ''
Sets the LSFG_DLL_PATH environment variable.
Required if Lossless Scaling isn't installed in a standard location
'';
};
};
};