diff --git a/options.xhtml b/options.xhtml index ad06e881c..1fb032a4a 100644 --- a/options.xhtml +++ b/options.xhtml @@ -39890,6 +39890,331 @@ YAML value

+
+ + programs.lutris.enable + + +
+
+

Whether to enable lutris…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.package + + +
+
+

The lutris package to use.

+ +

Type: +package

+ +

Default: +<derivation lutris-0.5.19>

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.extraPackages + + +
+
+

List of packages to pass as extraPkgs to lutris. +Please note runners are not detected properly this way, use a proper option for those.

+ +

Type: +list of package

+ +

Default: +[ ]

+ +

Example: +"with pkgs; [mangohud winetricks gamescope gamemode umu-launcher]"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.protonPackages + + +
+
+

List of proton packages to be added for lutris to use with umu-launcher.

+ +

Type: +list of package

+ +

Default: +[ ]

+ +

Example: +"[ pkgs.proton-ge-bin ]"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners + + +
+
+

Attribute set of Lutris runners along with their configurations. +Each runner must be named exactly as lutris expects on lutris --list-runners. +Note that runners added here won’t be configurable through Lutris using the GUI.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Example:

''
+  runners = {
+    cemu.package = pkgs.cemu;
+    pcsx2.config = {
+      system.disable_screen_saver = true;
+      runner.executable_path = "$\{pkgs.pcsx2}/bin/pcsx2-qt";
+    };
+  };
+''
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners.<name>.package + + +
+
+

The package to use for this runner, nix will try to find the executable for this package. +A more specific path can be set by using settings.runner.executable_path instead.

+ +

Type: +null or package

+ +

Default: +null

+ +

Example: +"pkgs.cemu"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners.<name>.settings + + +
+
+

Settings passed directly to lutris for this runner’s config at XDG_CONFIG/lutris/runners.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners.<name>.settings.runner + + +
+
+

Runner specific options. +For references, you must look for the file of said runner on lutris’ source code.

+ +

Type: +YAML value

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners.<name>.settings.runner.executable_path + + +
+
+

Specific option to point to a runner executable directly, don’t set runner.package if you set this.

+ +

Type: +string or absolute path

+ +

Default: +""

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.runners.<name>.settings.system + + +
+
+

Lutris system options for this runner. +Reference for system options: +https://github.com/lutris/lutris/blob/master/lutris/sysoptions.py#L78

+ +

Type: +YAML value

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.steamPackage + + +
+
+

This must be the same you use for your system, or two instances will conflict, +for example, if you configure steam through the nixos module, a good value is “osConfig.programs.steam.package”

+ +

Type: +null or package

+ +

Default: +null

+ +

Example: +"pkgs.steam or osConfig.programs.steam.package"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
+
+ + programs.lutris.winePackages + + +
+
+

List of wine packages to be added for lutris to use.

+ +

Type: +list of package

+ +

Default: +[ ]

+ +

Example: +"[ pkgs.wineWow64Packages.full ]"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/lutris.nix> + +
+
programs.man.enable