functorOS module options for 603941e7600cd409535b1abe153210f4c294918e

functorOS.enable

Whether to enable functorOS’s default modules and options for Linux.

Type: boolean

Default: true

Declared by: - /modules/linux

functorOS.config.allowUnfree

Whether to enable some proprietary packages required by certain functorOS modules. This does not set allowUnfree for the whole system, it merely allows the installation of a few proprietary packages such as Nvidia drivers, etc. You should still set this option even if you already set nixpkgs.config.allowUnfree for the whole system since it tells functorOS it can enable certain options that require proprietary packages.

Type: boolean

Default: false

Declared by: - /modules/linux/misc

functorOS.config.extraUnfreePackages

Packages to enable in allowUnfreePredicate

Type: list of string

Default: [ ]

Declared by: - /modules/linux/misc

functorOS.darwin.enable

Whether to enable functorOS’s default modules and options for Darwin.

Type: boolean

Default: false

Declared by: - /modules/default.nix

functorOS.defaultEditor

Default text editor that will be installed and set as $EDITOR. Set to null to disable setting and installing default text editor.

Type: null or package

Default: <derivation neovim-0.11.4>

Declared by: - /modules/linux/misc

functorOS.desktop.enable

Whether to enable the functorOS desktop environment.

Type: boolean

Default: true

Declared by: - /modules/linux/desktop-environment

functorOS.desktop.greeter.enable

Whether to enable and set up ly, the default greeter for functorOS.

Type: boolean

Default: true

Declared by: - /modules/linux/greeter

functorOS.desktop.greeter.command

Command for the greeter to execute to launch the desktop. If the functorOS Hyprland Desktop is enabled, defaults to Hyprland.

Type: string

Default: "Hyprland"

Declared by: - /modules/linux/greeter

functorOS.desktop.hyprland.enable

Whether to enable Hyprland. Sets up a default configuration at the system and user level, and installs xdg-desktop-portal-gtk.

Type: boolean

Default: true

Declared by: - /modules/linux/desktop-environment

functorOS.desktop.localization.chinese.input.enable

Whether to enable Chinese input method using fcitx5…

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/localization

functorOS.desktop.localization.chinese.script

Whether to use simplified or traditional characters.

Type: one of “simplified”, “traditional”

Default: "simplified"

Declared by: - /modules/linux/localization

functorOS.desktop.niri.enable

Whether to enable Niri compositor.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/desktop-environment

functorOS.extras.distrobox.enable

Whether to enable distrobox and podman.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/distrobox

functorOS.extras.gaming.enable

Whether to enable gaming.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/gaming

functorOS.extras.gaming.roblox.enable

Whether to install the Roblox Sober flatpak automatically. Note that this will enable the nix-flatpak service and automatic flatpak updates.`

Type: boolean

Default: false

Declared by: - /modules/linux/gaming

functorOS.extras.gaming.utilities.gamemode.enable

Whether to enable gamemode.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/gaming

functorOS.extras.gaming.utilities.gamemode.gamemodeUsers

List of users to add to the gamemode group. Gamemode will likely not work unless you add your user to the group!

Type: list of string

Default: [ ]

Declared by: - /modules/linux/gaming

functorOS.extras.gaming.utilities.hamachi.enable

Whether to enable hamachi.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/gaming

functorOS.flakeLocation

Absolute filepath location of the NixOS system configuration flake.

Type: null or absolute path

Default: null

Declared by: - /modules/linux/misc

functorOS.formFactor

Form factor of the machine. Adjusts some UI settings.

Type: null or one of “laptop”, “desktop”

Default: null

Declared by: - /modules/linux/misc

functorOS.integrateHomeManager

Whether to activate home manager with default options. Keep in mind you still have to import the functorOS home-manager module.

Type: boolean

Default: true

Declared by: - /hm

functorOS.powersave

Whether to set some options to reduce power consumption (mostly Hyprland).

Type: boolean

Default: false

Declared by: - /modules/linux/misc

functorOS.programs.flatpak.enable

Whether to enable Nix flatpak support with some fixes as well as declarative flatpak management.

Type: boolean

Default: false

Declared by: - /modules/linux/flatpak

functorOS.programs.wine.enable

Whether to enable wine.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/wine

functorOS.system.audio.enable

Whether to set up PipeWire and default audio utilities.

Type: boolean

Default: true

Declared by: - /modules/linux/audio

functorOS.system.audio.prod.enable

Whether to enable audio production.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/audio-prod

functorOS.system.audio.prod.realtimeAudioUsers

List of users to add to the audio group for realtime capabilities.

Type: list of string

Default: [ ]

Declared by: - /modules/linux/audio-prod

functorOS.system.core.enable

Whether to enable core functorOS system utilities and configurations (such as security policies, Nix options, etc)

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.bluetooth.enable

Whether to enable bluetooth and blueman.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.chinaOptimizations

Whether to enable optimizations for Nix operations in Mainland China. e.g. use the Tsinghua University binary cache, set firewall options to tunnel Nix binary cache operations past Mullvad VPN to preven throttling…

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/core

functorOS.system.core.customOSName

Whether to set the OS string to functorOS instead of NixOS. This means tools like neofetch/fastfetch will report your operating system as functorOS rather than NixOS. Note that we also patch fastfetch to display a custom logo if this is enabled.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.nixSaneDefaults

Whether to set sane defaults for Nix, such as optimization and automatic garbage collection.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.replaceSudoWithRun0

Whether to replace fully sudo with systemd-run0, systemd’s replacement for sudo. Unlike sudo, sudo-rs, or doas (dedicated openbsd application subexecutor), run0 is not a setuid program and relies solely on existing polkit privilege escalation infrastructure, reducing attack surface of the machine.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.suppressWarnings

Whether to enable suppress warnings.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/core

functorOS.system.core.useGvfs.enable

Whether to enable the GVFS and alias rm to send files to trash instead.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.useNh

Whether to enable the nh cli (yet another Nix helper), a reimplementation of some core NixOS utilities like nix-collect-garbage and nixos-rebuild. If enabled, automatic garbage collection will use nh instead of nix-collect-garbage and will be able to garbage collect result symlinks.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.uutils.enable

Whether to replace GNU coreutils with Rust uutils

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.core.waylandFixes

Whether to enable some Wayland fixes, like setting NIXOS_OZONE_WL to hint Electron apps to use the Wayland windowing system.

Type: boolean

Default: true

Declared by: - /modules/linux/core

functorOS.system.fonts.enable

Whether to set up some nice default fonts, including a Nerd Font, Noto Fonts, and CJK.

Type: boolean

Default: true

Declared by: - /modules/linux/misc

functorOS.system.graphics.enable

Whether to set up basic graphics settings and options.

Type: boolean

Default: true

Declared by: - /modules/linux/graphics

functorOS.system.graphics.nvidia.enable

Whether to enable recommended nvidia drivers and configuration.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/graphics

functorOS.system.graphics.nvidia.optimus-prime.enable

Whether to enable Nvidia OPTIMUS and PRIME.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/graphics

functorOS.system.graphics.nvidia.optimus-prime.powerMode

Whether to use Nvidia OPTIMUS with maximum performance using the discrete graphics card, or to use offload mode to primarily use the integrated GPU and save power.

Type: one of “powersaving”, “performance”

Default: "performance"

Declared by: - /modules/linux/graphics

functorOS.system.graphics.nvidia.suppressUnfreeWarning

Whether to disable the assertion that warns the user if they try to enable proprietary nvidia drivers without setting allowUnfree.

Type: boolean

Default: false

Declared by: - /modules/linux/graphics

functorOS.system.networking.enable

Whether to enable networking features.

Type: boolean

Default: true

Declared by: - /modules/linux/networking

functorOS.system.networking.backend

Which backend to use for networking. Default is wpa_supplicant with NetworkManager as a frontend. With iwd, iwctl is the frontend.

Type: one of “wpa_supplicant”, “iwd”

Default: "wpa_supplicant"

Declared by: - /modules/linux/networking

functorOS.system.networking.cloudflareNameservers.enable

Whether to enable Cloudflare DNS servers.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/networking

functorOS.system.networking.firewallPresets.grimDawn

Whether to enable firewall ports for Grim Dawn.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/networking

functorOS.system.networking.firewallPresets.terraria

Whether to enable firewall ports for Terraria.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/networking

functorOS.system.networking.firewallPresets.vite

Whether to enable firewall ports for Vite.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/networking

functorOS.system.printing.enable

Whether to set up default options for printing and printer discover on UNIX.

Type: boolean

Default: true

Declared by: - /modules/linux/misc

functorOS.theming.enable

Whether to uniformly theme the entire system using Stylix.

Type: boolean

Default: true

Declared by: - /modules/linux/stylix

functorOS.theming.base16Scheme

Base 16 colorscheme from base16-schemes to override wallpaper generated colorscheme with. Set to null to use wallpaper generated scheme. Example: ${pkgs.base16-schemes}/share/themes/rose-pine.yaml

Type: null or absolute path

Default: null

Declared by: - /modules/linux/stylix

functorOS.theming.plymouth.enable

Whether to enable plymouth and sane defaults.

Type: boolean

Default: true

Declared by: - /modules/linux/stylix

functorOS.theming.polarity

Whether to force colorscheme to be generated as light or dark theme. Set to null to automatically determine.

Type: null or one of “light”, “dark”

Default: null

Declared by: - /modules/linux/stylix

functorOS.theming.wallpaper

Path to wallpaper to set as background and generate system colorscehme from.

Type: anything

Default: "../../../hm/modules/common/shellenv/fastfetch/nixos-logo.png"

Declared by: - /modules/linux/stylix

functorOS.useEnUsLocale

Whether to use the en_US locale automatically

Type: boolean

Default: true

Declared by: - /modules/linux/misc

functorOS.wsl.enable

Whether to enable WSL.

Type: boolean

Default: false

Example: true

Declared by: - /modules/linux/wsl