Files
Nomarchy/docs/OVERRIDES.md
Bernardo Magri dc33694a56
All checks were successful
Check / eval (push) Successful in 3m24s
docs(overrides): user guide for opt-in icon packs
The only doc for the icon-pack override was a comment in the downstream
template. Add an "Icon pack" subsection to docs/OVERRIDES.md § Appearance
(the user-facing appearance-customization doc): the
`nomarchy-theme-sync set icons "<name>"` command, why only Papirus ships
by default (~1 GiB; extra packs opt-in), a known-packs table, and that
the choice is sticky across `apply` (presets carry no icon field).

Example names verified by building all four packs and listing their real
theme directories — corrected Qogir to its capitalized Qogir-Dark/Light
(a lowercase name silently falls back to hicolor). Hibernation needs no
new doc (README swapfile note + MIGRATION.md runbook + Power-menu row).

Verification: V0 (docs-only); command + variant names checked live.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-10 20:34:00 +01:00

6.4 KiB

Overriding Nomarchy's defaults

You consume Nomarchy as a flake input and own two files: system.nix and home.nix. Your config is merged with Nomarchy's modules, so changing a default is just a matter of knowing which of three knobs to reach for. The rule of thumb:

Appearance → the CLI. Behaviour → home.nix. Whole component → toggle it off.

1. Appearance (gaps, colors, rounding, fonts, opacity) — use the CLI

Everything that defines the look flows from theme-state.json, the single source of truth. Change it with nomarchy-theme-sync, which writes the JSON and rebuilds — one generation, applied to Hyprland, Waybar, Ghostty, btop and Stylix at once:

nomarchy-theme-sync set ui.gapsOut 16      # gaps, borders, rounding, opacity
nomarchy-theme-sync set ui.rounding 0
nomarchy-theme-sync set fonts.mono "FiraCode Nerd Font"
nomarchy-theme-sync apply gruvbox          # whole palette

Icon pack

Icons follow the active theme's light/dark mode using Papirus — the only icon pack shipped by default (Papirus alone is ~1 GiB, so extra packs are opt-in rather than a cost every install pays). To switch to another pack:

nomarchy-theme-sync set icons "Tela-dark"  # or "" to return to Papirus-by-mode

Only the pack you name is pulled into your system (the first switch downloads it). Known packs and an example theme name from each:

Set icons to… Pack
Papirus, Papirus-Dark, Papirus-Light Papirus (default; "" auto-picks Dark/Light by mode)
Tela, Tela-dark, Tela-<color>[-dark] Tela (colors: blue, green, red, purple, nord, dracula, …)
Qogir, Qogir-Dark, Qogir-Light Qogir (note the capital D/L)
Reversal, Reversal-dark Reversal
Numix-Circle, Numix-Circle-Light Numix Circle

The choice is a sticky global override — it survives apply <palette> switches (presets don't carry an icon field). To add a pack that isn't listed, append a row to iconPacks in modules/home/theme.nix. Set icons to "" any time to drop back to Papirus with automatic Dark/Light.

These values are deliberately kept at normal priority in the modules, so they stay owned by the theme system. If you insist on pinning one in home.nix regardless of the active theme, use lib.mkForce (see §4) — but then the CLI can no longer change that knob.

2. Behaviour (input, misc, monitor, animations, terminal chrome) — home.nix

Non-appearance defaults are set with lib.mkDefault, so a plain assignment in your home.nix wins — no mkForce needed:

# home.nix
{ ... }:
{
  wayland.windowManager.hyprland.settings = {
    input.follow_mouse = 0;            # was 1
    input.touchpad.natural_scroll = false;
    misc.disable_splash_rendering = false;
    monitor = [ "DP-1,2560x1440@144,0x0,1" ];   # raw rule — replaces the default
    animations.enabled = false;
  };

  programs.ghostty.settings = {
    window-padding-x = 4;              # was 12
    window-decoration = true;
  };
}

For monitor layout, prefer the friendlier nomarchy.monitors (a list of per-output submodules — resolution/position/scale/rotation — turned into Hyprland rules and applied on hotplug; run nwg-displays to find the values interactively). Assigning settings.monitor directly, as above, replaces it.

Adding vs. overriding lists

bind, bindel, bindl, bindm and exec-once are lists kept at normal priority, so anything you add concatenates with Nomarchy's — your binds and autostarts run alongside the defaults:

{
  wayland.windowManager.hyprland.settings = {
    bind = [
      "$mod, B, exec, firefox"
      "$mod SHIFT, S, exec, grim -g \"$(slurp)\" - | satty --filename -"
    ];
    exec-once = [ "nm-applet --indicator" ];
  };
}

To remove or replace a default bind, override the whole bind list with lib.mkForce [ … ] (you then own the full list), or rebind the key to something else (last definition for a key wins in Hyprland).

You can also drop raw config that doesn't fit the Nix schema:

{ wayland.windowManager.hyprland.extraConfig = ''
    bindl = , switch:Lid Switch, exec, hyprlock
  '';
}

Waybar

For a themed bar identity, ship whole-swap assets (themes/<slug>/waybar.jsonc and waybar.css) — see the main README. To replace the bar wholesale from home.nix, assign programs.waybar.settings. mainBar / programs.waybar.style (both mkDefault, so a plain assignment wins). For a one-off tweak of a single generated key, lib.mkForce it.

3. Whole component — toggle it off and bring your own

Each desktop piece has an enable flag (all default true). Turn one off and Nomarchy contributes nothing for it, leaving the field clear for your own:

# home.nix
{
  nomarchy.hyprland.enable = false;   # then write your own wayland.windowManager.hyprland
  nomarchy.waybar.enable = false;
  nomarchy.swaync.enable = false;
  nomarchy.idle.enable = false;       # no hyprlock/hypridle
}
# system.nix
{
  nomarchy.system.plymouth.enable = false;
  nomarchy.system.greeter.enable = false;   # bring your own login manager
}

See the option tables in the README for the full list.

4. Last resort: lib.mkForce

To override a value Nomarchy sets at normal priority (an appearance value, or a whole list), raise your definition's priority:

{ lib, ... }:
{
  # hardcode rounding against the theme (the CLI can no longer change it)
  wayland.windowManager.hyprland.settings.decoration.rounding = lib.mkForce 0;

  # own the entire keybind list
  wayland.windowManager.hyprland.settings.bind = lib.mkForce [ "$mod, Return, exec, kitty" ];
}

If a plain assignment errors with "has conflicting definition values", that value is theme-owned at normal priority — either change it via the CLI (§1) or mkForce it here.

Quick reference

You want to… Do this
Change gaps / colors / rounding / fonts nomarchy-theme-sync set … or apply
Change input / misc / monitor / animations / terminal chrome plain assignment in home.nix
Arrange monitors declaratively nomarchy.monitors (values via nwg-displays)
Add keybinds / autostarts add to the bind / exec-once list (concatenates)
Replace all keybinds bind = lib.mkForce [ … ]
Hardcode an appearance value against the theme lib.mkForce in home.nix
Drop a whole component nomarchy.<component>.enable = false
Raw Hyprland lines wayland.windowManager.hyprland.extraConfig