{ config, pkgs, lib, ... }: with lib; let cfg = config.programs.sway; wrapperOptions = types.submodule { options = let mkWrapperFeature = default: description: mkOption { type = types.bool; inherit default; example = !default; description = lib.mdDoc "Whether to make use of the ${description}"; }; in { base = mkWrapperFeature true '' base wrapper to execute extra session commands and prepend a dbus-run-session to the sway command. ''; gtk = mkWrapperFeature false '' wrapGAppsHook wrapper to execute sway with required environment variables for GTK applications. ''; }; }; defaultSwayPackage = pkgs.sway.override { extraSessionCommands = cfg.extraSessionCommands; extraOptions = cfg.extraOptions; withBaseWrapper = cfg.wrapperFeatures.base; withGtkWrapper = cfg.wrapperFeatures.gtk; isNixOS = true; }; in { options.programs.sway = { enable = mkEnableOption (lib.mdDoc '' Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to ~/.config/sway/config to modify the default configuration. See and "man 5 sway" for more information''); package = mkOption { type = with types; nullOr package; default = defaultSwayPackage; defaultText = literalExpression "pkgs.sway"; description = lib.mdDoc '' Sway package to use. Will override the options 'wrapperFeatures', 'extraSessionCommands', and 'extraOptions'. Set to `null` to not add any Sway package to your path. This should be done if you want to use the Home Manager Sway module to install Sway. ''; }; wrapperFeatures = mkOption { type = wrapperOptions; default = { }; example = { gtk = true; }; description = lib.mdDoc '' Attribute set of features to enable in the wrapper. ''; }; extraSessionCommands = mkOption { type = types.lines; default = ""; example = '' # SDL: export SDL_VIDEODRIVER=wayland # QT (needs qt5.qtwayland in systemPackages): export QT_QPA_PLATFORM=wayland-egl export QT_WAYLAND_DISABLE_WINDOWDECORATION="1" # Fix for some Java AWT applications (e.g. Android Studio), # use this if they aren't displayed properly: export _JAVA_AWT_WM_NONREPARENTING=1 ''; description = lib.mdDoc '' Shell commands executed just before Sway is started. See and for some useful environment variables. ''; }; extraOptions = mkOption { type = types.listOf types.str; default = []; example = [ "--verbose" "--debug" "--unsupported-gpu" ]; description = lib.mdDoc '' Command line arguments passed to launch Sway. Please DO NOT report issues if you use an unsupported GPU (proprietary drivers). ''; }; extraPackages = mkOption { type = with types; listOf package; default = with pkgs; [ swaylock swayidle foot dmenu ]; defaultText = literalExpression '' with pkgs; [ swaylock swayidle foot dmenu ]; ''; example = literalExpression '' with pkgs; [ i3status i3status-rust termite rofi light ] ''; description = lib.mdDoc '' Extra packages to be installed system wide. See and for a list of useful software. ''; }; }; config = mkIf cfg.enable (mkMerge [ { assertions = [ { assertion = cfg.extraSessionCommands != "" -> cfg.wrapperFeatures.base; message = '' The extraSessionCommands for Sway will not be run if wrapperFeatures.base is disabled. ''; } ]; environment = { systemPackages = optional (cfg.package != null) cfg.package ++ cfg.extraPackages; # Needed for the default wallpaper: pathsToLink = optionals (cfg.package != null) [ "/share/backgrounds/sway" ]; etc = { "sway/config.d/nixos.conf".source = pkgs.writeText "nixos.conf" '' # Import the most important environment variables into the D-Bus and systemd # user environments (e.g. required for screen sharing and Pinentry prompts): exec dbus-update-activation-environment --systemd DISPLAY WAYLAND_DISPLAY SWAYSOCK XDG_CURRENT_DESKTOP ''; } // optionalAttrs (cfg.package != null) { "sway/config".source = mkOptionDefault "${cfg.package}/etc/sway/config"; }; }; # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1050913 xdg.portal.config.sway.default = mkDefault [ "wlr" "gtk" ]; # To make a Sway session available if a display manager like SDDM is enabled: services.xserver.displayManager.sessionPackages = optionals (cfg.package != null) [ cfg.package ]; } (import ./wayland-session.nix { inherit lib pkgs; }) ]); meta.maintainers = with lib.maintainers; [ primeos colemickens ]; }