mirror of
https://github.com/lhns/steam-frame-nix.git
synced 2026-10-06 07:00:27 +02:00
Pierre Kisters
65f5ccde9b
Descriptions say what, default and notable caveats; the mkPatch calling convention is referenced from lib/default.nix instead of repeated.
215 lines
8.0 KiB
Nix
215 lines
8.0 KiB
Nix
# The VR dashboard's "+" menu (non-Steam programs). Steam lists them in GLib
|
|
# hash-table order (random-looking). Runtime patches in SharedJSContext, each
|
|
# registered only when its option is set, reverted when unset (next switch):
|
|
# - order/: sorts ScanForInstalledNonSteamApps() by name;
|
|
# - pinned-desktop/: hides Desktop in the list, pins a proxy above/below it;
|
|
# - launch/: wraps LaunchNonSteamApp (menu-only) to close the menu and/or
|
|
# debounce repeated launches;
|
|
# - grid/: programs as a grid of tiles, optionally maxRows visible;
|
|
# - show-all/: empties the list Steam hides without Developer Mode.
|
|
# Tested with Steam client 1790377368.
|
|
#
|
|
# iconFallbacks (not a patch): Steam resolves Icon= names only in hicolor (and
|
|
# pixmaps), so Breeze-only icons (Konsole, KDE System Settings) are missing;
|
|
# icon-fallbacks.sh links them from nixpkgs' Breeze into
|
|
# ~/.local/share/icons/hicolor on switch. It was a list of names until 2026-09;
|
|
# a list now fails with a pointer to enable/extra.
|
|
{ config, lib, pkgs, ... }:
|
|
let
|
|
cfg = config.steamFrame.launcherMenu;
|
|
inherit (import ./lib { inherit pkgs; }) mkPatch;
|
|
sharedJSContext = { title = "SharedJSContext"; };
|
|
|
|
iconFallbacks = pkgs.writeShellApplication {
|
|
name = "steam-frame-icon-fallbacks";
|
|
runtimeInputs = [ pkgs.coreutils pkgs.findutils pkgs.gawk ];
|
|
text = builtins.readFile ./launcher-menu/icon-fallbacks.sh;
|
|
};
|
|
in {
|
|
imports = [ ./steam-ui-patches.nix ];
|
|
|
|
options.steamFrame.launcherMenu = {
|
|
sort = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = false;
|
|
description = ''
|
|
Sort the "+" menu (non-Steam programs) by name. Runtime patch.
|
|
'';
|
|
};
|
|
pinDesktop = lib.mkOption {
|
|
type = lib.types.nullOr (lib.types.enum [ "top" "bottom" ]);
|
|
default = null;
|
|
example = "bottom";
|
|
description = ''
|
|
Pin "Desktop" (the nested Plasma session) above ("top") or below
|
|
("bottom") the "+" menu's scrolling list, so it is always visible;
|
|
null = normal list entry. Runtime patch.
|
|
'';
|
|
};
|
|
closeOnLaunch = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = false;
|
|
description = ''
|
|
Close the "+" menu as soon as a program is launched (stock: it stays
|
|
open until the window appears, inviting double launches). Runtime patch.
|
|
'';
|
|
};
|
|
launchDebounce = lib.mkOption {
|
|
type = lib.types.ints.unsigned;
|
|
default = 0;
|
|
example = 10;
|
|
description = ''
|
|
Ignore another "+" menu launch of the same command line within this
|
|
many seconds of the last one that went through (logged); 0 = off.
|
|
Runtime patch.
|
|
'';
|
|
};
|
|
grid = {
|
|
enable = lib.mkEnableOption ''
|
|
the "+" menu's programs as a grid of tiles (icon, name below) instead
|
|
of a list. Runtime patch'';
|
|
columns = lib.mkOption {
|
|
type = lib.types.ints.between 1 8;
|
|
default = 4;
|
|
description = ''
|
|
Tiles per row (the menu is 300 px wide: 3 → ~92 px tiles, 4 → ~68,
|
|
5 → ~53).
|
|
'';
|
|
};
|
|
maxRows = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.ints.positive;
|
|
default = null;
|
|
example = 4;
|
|
description = ''
|
|
Rows visible at once (the rest scrolls); null = up to the menu's
|
|
stock max height (600 px).
|
|
'';
|
|
};
|
|
};
|
|
showAllApps = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = false;
|
|
description = ''
|
|
List all programs in the "+" menu without Developer Mode (Steam
|
|
otherwise hides konsole, systemsettings, dolphin, plasma-discover, vlc,
|
|
firewall-config, cmake-gui, qrenderdoc, lxterminal, sh). Developer Mode
|
|
itself is untouched; hide single programs with steamFrame.hiddenApps.
|
|
Runtime patch.
|
|
'';
|
|
};
|
|
iconFallbacks = lib.mkOption {
|
|
default = { };
|
|
description = ''
|
|
Hicolor links for program icons only Breeze has, so the "+" menu shows
|
|
them (Steam looks only in hicolor).
|
|
'';
|
|
# Formerly a list of names: fail with a message instead (see assertion).
|
|
type = lib.types.coercedTo (lib.types.listOf lib.types.str)
|
|
(names: { legacyList = names; })
|
|
(lib.types.submodule {
|
|
options = {
|
|
enable = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = true;
|
|
description = ''
|
|
On switch, for each Icon= of the desktop entries Steam sees
|
|
that hicolor lacks but nixpkgs' Breeze has (SteamOS:
|
|
utilities-terminal, preferences-system), link the Breeze SVG
|
|
into ~/.local/share/icons/hicolor/scalable/apps. Only its own
|
|
links (listed in ~/.local/state/steam-frame-nix/icon-fallbacks)
|
|
are touched; stale ones are removed; false removes all.
|
|
'';
|
|
};
|
|
extra = lib.mkOption {
|
|
type = lib.types.listOf (lib.types.strMatching "[A-Za-z0-9._+-]+");
|
|
default = [ ];
|
|
example = [ "system-file-manager" ];
|
|
description = ''
|
|
Extra icon names to provide (if hicolor lacks them); names
|
|
Breeze doesn't have are reported and skipped.
|
|
'';
|
|
};
|
|
legacyList = lib.mkOption {
|
|
type = lib.types.nullOr (lib.types.listOf lib.types.str);
|
|
default = null;
|
|
internal = true;
|
|
visible = false;
|
|
};
|
|
};
|
|
});
|
|
};
|
|
};
|
|
|
|
config.assertions = [ {
|
|
assertion = cfg.iconFallbacks.legacyList == null;
|
|
message = ''
|
|
steamFrame.launcherMenu.iconFallbacks is no longer a list of icon names
|
|
(set to ${builtins.toJSON cfg.iconFallbacks.legacyList}). Use
|
|
iconFallbacks.enable = true; # default: utilities-terminal, preferences-system
|
|
iconFallbacks.extra = [ ... ]; # further names
|
|
or iconFallbacks.enable = false; for none (what [ ] used to mean).
|
|
'';
|
|
} ];
|
|
|
|
# After installPackages so the new profile counts; without BREEZE_APPS the
|
|
# script removes its links.
|
|
config.home.activation.steamFrameIconFallbacks =
|
|
lib.hm.dag.entryAfter [ "writeBoundary" "installPackages" ] (
|
|
if cfg.iconFallbacks.enable then ''
|
|
run env BREEZE_APPS=${pkgs.kdePackages.breeze-icons}/share/icons/breeze/apps \
|
|
${lib.getExe iconFallbacks} ${lib.escapeShellArgs cfg.iconFallbacks.extra}
|
|
'' else ''
|
|
run ${lib.getExe iconFallbacks}
|
|
'');
|
|
|
|
config.steamFrame.uiPatches.patches =
|
|
lib.optional cfg.sort {
|
|
name = "launcher-menu-order";
|
|
target = sharedJSContext;
|
|
patch = ./launcher-menu/order/patch.js;
|
|
unpatch = ./launcher-menu/order/unpatch.js;
|
|
}
|
|
++ lib.optional (cfg.pinDesktop != null) {
|
|
name = "launcher-menu-pinned-desktop";
|
|
target = sharedJSContext;
|
|
patch = mkPatch {
|
|
name = "launcher-menu-pinned-desktop";
|
|
src = ./launcher-menu/pinned-desktop/patch.js;
|
|
opts.position = cfg.pinDesktop;
|
|
};
|
|
unpatch = ./launcher-menu/pinned-desktop/unpatch.js;
|
|
}
|
|
++ lib.optional (cfg.closeOnLaunch || cfg.launchDebounce > 0) {
|
|
name = "launcher-menu-launch";
|
|
target = sharedJSContext;
|
|
patch = mkPatch {
|
|
name = "launcher-menu-launch";
|
|
src = ./launcher-menu/launch/patch.js;
|
|
opts = {
|
|
inherit (cfg) closeOnLaunch;
|
|
debounceSeconds = cfg.launchDebounce;
|
|
};
|
|
};
|
|
unpatch = ./launcher-menu/launch/unpatch.js;
|
|
}
|
|
++ lib.optional cfg.grid.enable {
|
|
name = "launcher-menu-grid";
|
|
target = sharedJSContext;
|
|
patch = mkPatch {
|
|
name = "launcher-menu-grid";
|
|
src = ./launcher-menu/grid/patch.js;
|
|
opts = { inherit (cfg.grid) columns maxRows; };
|
|
};
|
|
unpatch = ./launcher-menu/grid/unpatch.js;
|
|
}
|
|
++ lib.optional cfg.showAllApps {
|
|
name = "launcher-menu-show-all";
|
|
target = sharedJSContext;
|
|
patch = mkPatch {
|
|
name = "launcher-menu-show-all";
|
|
src = ./launcher-menu/show-all/patch.js;
|
|
};
|
|
unpatch = ./launcher-menu/show-all/unpatch.js;
|
|
};
|
|
}
|