Skip to content
Michael Palmos edited this page Jun 9, 2022 · 19 revisions

Configuration

File

Wired doesn't create a config for you. If a config isn't found, Wired will use the default config, which can be found in the root of the repository.

Wired looks for a config file in the following locations:

  1. $XDG_CONFIG_HOME/wired/wired.ron
  2. $XDG_CONFIG_HOME/wired.ron
  3. $HOME/.config/wired/wired.ron
  4. $HOME/wired.ron

Required Properties

Name Type Description Example
max_notifications int Maximum number of notifications shown at any one time. A value of 0 means there is no limit. max_notifications: 0
timeout int The default timeout, in milliseconds, for notifications that don't have an initial timeout set. 1000ms = 1s. timeout: 10000
poll_interval int The update rate, in milliseconds. This decides how often notifications update, including how often they redraw (if required). 16ms ~= 60hz poll_interval: 16
shortcuts ShortcutsConfig Configuration for preset shortcuts. See the shortcuts config page for more information. See shortcuts page.

Optional Properties

Name Type Description Example
history_length 'int` How many notifications are kept in history.
Each notification is roughly 256 bytes (excluding buffers), so do the math there.
Default: 10
history_length: 10
replacing_enabled bool Enable/disable replacement functionality.
If this is disabled, replacement requests will just send a new notification.
E.g., with replacing_enabled: true, Pidgin will only show the latest message from each contact, instead of sending a new one for each message.
Default: true
replacing_enabled: true
replacing_resets_timeout bool Whether a notification should reset its timeout when it is replaced.
No effect if replacing_enabled is false.
Default: false
replacing_resets_timeout: false
closing_enabled bool Enable/disable closing functionality.
You can still close notifications yourself, apps just can't do it for you.
Default: true
closing_enabled: true
idle_threshold int Wired will pause notifications if you are idle (no mouse or keyboard input) for longer than idle_threshold seconds.
Notifications are not automatically unpaused on wake, and will need to be manually cleared.
Default: None (disabled)
idle_threshold: 3600
focus_follows FollowMode When a NotificationBlock has monitor: -1 (i.e. should follow active monitor, then what input should we use to determine the active monitor? focus_follows: Mouse
focus_follows: Window
print_to_file string Enable printing notification data to a file, which can be useful for scripting purposes. The data is written as JSON.
Default: None (disabled)
print_to_file: "/tmp/wired.log"
debug bool Enable/disable debug rendering.
Default: false
debug: false
debug_color Color Primary color for debug rectangles.
Default: Color(r: 0.0, g: 1.0, b: 0.0, a: 1.0)
debug_color: Color(r: 0.0, g: 1.0, b: 0.0, a: 1.0)
debug_color_alt Color Secondary color for debug rectangles.
Default: Color(r: 1.0, g: 0.0, b: 0.0, a: 1.0)
debug_color_alt: Color(r: 1.0, g: 0.0, b: 0.0, a: 1.0)