Skip to content

CONFIGURE.md

Latest commit

 

History

History
44 lines (30 loc) · 2.54 KB

CONFIGURE.md

File metadata and controls

44 lines (30 loc) · 2.54 KB
Raw

Config

The main config file is located at ~/.config/switcharoo/config.json (or .ron, .toml) but can be configured using the -c argument. The config is loaded at startup and is reloaded when the file changes.

In case this documentation is outdated, look at the struct definition for the most up-to-date information.

Config Options

  • version:[number] The version of the config file. (Current: 5)
  • windows:[Windows?] Configuration for the switcher windows.

Windows

  • scale:[number] The scale used to scale down the real dimension the windows displayed. Can be set from 0.0 < X > to 15.0 (Default: 8.5)
  • items_per_row:[number] The number of windows to show per row. (Default: 5)
  • switch:[Switch?] Configuration for the primary switch mode.
  • switch_2:[Switch?] Configuration for an optional secondary switch mode.

Switch

This mode displays the windows sorted by their most recent access.

  • modifier:[string] The modifier that must be held down together with the tab key to open the Switch mode (for example alt). Letting go of this key will close the Switch mode. This MUST be one of these modifiers: alt, ctrl, super.
  • key:[string] The key to use (Default: "Tab").
  • filter_by[List] Filter the windows by the provided filter. (example: filter_by: [current_workspace])
    • same_class: Only includes windows of the same class / type.
    • current_workspace: Only includes windows of the current workspace.
    • current_monitor: Only includes windows of the current monitor.
  • switch_workspaces:[boolean] Switch between workspaces instead of windows.
  • show_workspace_number:[boolean] Show the workspace number/name label. (Default: true)
  • kill_key:[string] Key to kill the selected window (Default: 'q').
  • exclude_workspaces:[string] Regex for workspaces to exclude.

CSS

The CSS file is located at ~/.config/switcharoo/styles.css but can be configured using the -s argument. The config is loaded at startup and is reloaded when the file changes.

GTK only supports a subset of CSS, so not all CSS properties will work. The supported properties are listed in the GTK documentation.

The application defaults can be found in the CSS files inside the codebase (for example, this one or that one).

If you want to change colors borders, etc. you can edit the CSS variables in the :root {} section.