Mox

About

Welcome to Mox, a modern Wayland desktop environment built from the ground up in memory‑safe Rust. Mox strips away heavyweight GUI libraries and instead drives your hardware directly—so every pixel and frame is fully accelerated.

Key features:

• Zero GUI libraries
  Mox relies directly on Wayland and Vulkan, keeping the entire stack small, auditable, and lightning‑fast.

• Fully hardware-accelerated
  Different components use either Vulkan or WGPU, depending on their needs, for optimal performance.

• Memory-safe core
  Written entirely in Rust, Mox ensures safety without sacrificing speed.

• Keyboard-first design
  The entire environment is operable using only the keyboard, making it fast, efficient, and accessible.

moxidle

moxidle is an idle management daemon for mox desktop environment

Configuration

Moxidle's configuration is written in Lua and is located at $XDG_CONFIG_HOME/moxidle/config.lua or ~/.config/moxidle/config.lua. A config file is required; moxidle won’t run without one.

General

Timeouts

Moxidle uses timeouts to define actions on idleness.

When conditions are met and the system is idle, the timeout countdown (in seconds) begins. After the timeout duration, on_timeout is triggered. When user activity resumes, on_resume is executed.

Example timeout:

{
  conditions = { "on_battery" },             -- Conditions that must be fullfilled for timeout to begin
  timeout = 300,                             -- In seconds
  on_timeout = "notify-send 'You are idle!'"   -- Command to run when timeout has passed.
  on_resume = "notify-send 'Welcome back!'", -- Command to run when activity is detected after timeout has fired.
},

You can define as many listeners as you want.

Full example with hyprlock

return {
  general = {
    lock_cmd = "pidof hyprlock || hyprlock",                 -- If hyprlock isn't running, start it. Prevents multiple instances.
    before_sleep_cmd = "loginctl lock-session",              -- Locks the session before the system sleeps.
  },

  timeouts = {
    {
      conditions = { "on_battery", { battery_below = 20 } }, -- Applies when on battery and battery is below 20%.
      timeout = 300,                                         -- Waits 5 minutes (300 seconds) of inactivity.
      on_timeout = "systemctl suspend",                      -- Suspends the system when timeout hits.
    },

    {
      conditions = { "on_ac" },                              -- Applies when plugged into AC power.
      timeout = 300,                                         -- Waits 5 minutes.
      on_timeout = "pidof hyprlock || hyprlock",             -- Locks the screen if not already locked.
    },
    {
      conditions = { "on_ac" },                              -- Still on AC power.
      timeout = 900,                                         -- Waits 15 minutes.
      on_timeout = "systemctl suspend",                      -- Suspends the system after 15 minutes of inactivity.
    },
  },
}

Conditions

• on_battery:

  • Triggers when the system is running on battery power (not plugged into AC).

• on_ac:

  • Triggers when the system is plugged into an AC power source.

• battery_below = <int>:

  • Triggers when the battery level is below the specified percentage (e.g., battery_below = 20).

• battery_above = <int>:

  • Triggers when the battery level is above the specified percentage (e.g., battery_above = 80).

• battery_equal = <int>:

  • Triggers when the battery level is equal to the specified percentage (e.g., battery_equal = 50).

• battery_equal = <int>:

  • Triggers when the battery level is equal to the specified percentage (e.g., battery_equal = 50).

• battery_level = <BatteryLevel>:

  • Triggers when the battery level is equal to the specified level (e.g., battery_level = critical).

• battery_state = <BatteryState>:

  • Triggers when the battery state is equal to the specified state (e.g., battery_state = charging).

Valid BatteryLevel Values

• "unkown" or 0
• "none" or 1
• "low" or 3
• "critical" or 4
• "normal" or 6
• "high" or 7
• "full" or 8

Valid BatteryState Values

• "unkown" or 0
• "charging" or 1
• "discharging" or 2
• "empty" or 3
• "fully_charged" or 4
• "pending_charge" or 5
• "pending_discharge" or 6

moxnotify

moxnotify is a notification server for the mox desktop environment. It handles system notifications with customizable appearance, behavior, and sound options.

Configuration

Moxnotify's configuration is written in Lua and located at:

• $XDG_CONFIG_HOME/moxnotify/config.lua or
• ~/.config/moxnotify/config.lua

General Configuration

Example General Configuration

general = {
  margin = 0,  -- Alternatively, you can use a table: { top = 0, right = 0, bottom = 0, left = 0 }
  history = {
    size = 1000,
    path = "~/.local/share/moxnotify/db.mox"
  },
  default_sound_file = "/run/current-system/sw/share/sounds/freedesktop/stereo/message.oga",  -- you can also use a table to map urgency levels if needed
  ignore_sound_file = false,
  hint_characters = "sadfjklewcmpgh",
  scroll_sensitivity = 20.0,
  max_visible = 5,
  icon_size = 64,
  app_icon_size = 24,
  anchor = "top_right",  -- Default anchor position
  layer = "overlay",     -- Default layer for notifications
  queue = "unordered",   -- Default queue type
  output = nil,          -- nil means notifications will display on output chosen by compositor (Usually the one currently focused)
  default_timeout = {
    urgency_low = 5,
    urgency_normal = 10,
    urgency_critical = 0
  },
  ignore_timeout = false
}

Keymaps

Moxnotify allows you to define custom keymaps for interacting with notifications inspired by vim. Each keymap consists of the following properties:

• mode: The mode in which the keymap is active (e.g., "n" for normal mode).
• keys: The key or combination of keys that trigger the action.
• action: The command that is executed when the key(s) are pressed.

Keymap Modes

Keymap Actions

Example Keymaps Configuration

keymaps = {
  {
    mode = "n";
    keys = "d";
    action = "dismiss_notification";
  },
  {
    mode = "n";
    keys = "<C-g>";
    action = "last_notification";
  },
  {
    mode = "n";
    keys = "gw";
    action = "hint_mode";
  },
  {
    mode = "n";
    keys = "f";
    action = "noop";
  }
}

Styling System

Each style rule customizes notifications based on a selector (which notifications it applies to) and an optional state (interaction state).

Style Rule Properties

Style Properties

Example Styles Configuration

styles = {
  {
    selector = "*",
    style = {
      border = {
        color = {
          urgency_critical = "#f38ba8",
          urgency_low = "#a6e3a1",
          urgency_normal = "#cba6f7"
        }
      },
      font = {
        color = "#cdd6f4",
        family = "DejaVu Sans",
        size = 10
      }
    }
  },
  {
    selector = {
      "next_counter",
      "prev_counter",
      "notification",
      "hints"
    },
    style = {
      background = {
        urgency_critical = "#181825FF",
        urgency_low = "#1e1e2eFF",
        urgency_normal = "#181825FF"
      }
    }
  },
  {
    selector = "notification",
    state = "hover",
    style = {
      background = {
        urgency_critical = "#313244FF",
        urgency_low = "#313244FF",
        urgency_normal = "#313244FF"
      }
    }
  },
  {
    selector = "action",
    state = "hover",
    style = {
      background = {
        urgency_critical = "#f38ba8",
        urgency_low = "#f2cdcd",
        urgency_normal = "#f2cdcd"
      }
    }
  },
  {
    selector = "progress",
    style = {
      background = {
        urgency_critical = "#f38ba8",
        urgency_low = "#f2cdcd",
        urgency_normal = "#f2cdcd"
      }
    }
  },
  {
    selector = "dismiss",
    style = {
      font = {
        color = "#00000000"
      }
    }
  },
  {
    selector = "dismiss",
    state = "container_hover",
    style = {
      font = {
        color = "#000000"
      }
    }
  }
}

Special Types

Queue

• unordered: Every notification expires independently without order
• fifo: Notifications expire one by one in the order they arrived (First In, First Out)

Anchor

• top_right: Notifications appear in the top-right corner
• top_center: Notifications appear at the top
• top_left: Notifications appear in the top-left corner
• bottom_left: Notifications appear in the bottom-left corner
• bottom_center: Notifications appear at the bottom
• bottom_right: Notifications appear in the bottom-right corner
• center-right: Notifications appear at the right of the screen
• center: Notifications appear in the center of the screen
• center-left: Notifications appear at the left of the screen

Layer

• background: Notifications appear behind regular windows
• bottom: Notifications appear above background but below regular windows
• top: Notifications appear above regular windows
• overlay: Notifications appear above all other windows

Selector

• all: Every element
• prev_counter: The "previous" badge
• next_counter: The "next" badge
• all_notifications: The whole notification list
• notification = <string>: A specific notification instance
• action_button: Any action button
• dismiss_button: The dismiss ("×") button
• progress: Progress bar
• icon: The notification's icon
• hints: Keyboard hint overlays

States

The State enum controls when a style fires:

• default: Normal, resting state
• hover: When the mouse is over the target
• container_hover: When the mouse is anywhere over the notification container
• container_hover = <string>: Hover state for a container with a specific name

moxctl