3cdb3d03d88aab6fd2b2403a6297b69d94ce5e25

Message

Document default values in README, link my dots as a reference

Diff

This diff is truncated to protect this page.

  1diff --git a/README.md b/README.md
  2index 2f62c93944cbf08c6c5a416e9dbcb955cec7c9dc..7ab51b47dec5bafa86c5c576ecbaafe26c97d973 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -123,88 +123,89 @@ You can use `hy3:makegroup` to create a new split.
  6 
  7 The [dispatcher list](#dispatcher-list) and [config fields](#config-fields) sections have all the
  8 configuration options, and some explanation as to what they do.
  9+[The hyprland config in my dots](https://git.outfoxxed.me/outfoxxed/nixnew/src/branch/master/modules/hyprland/hyprland.conf) can also be used as a reference.
 10 
 11 ### Config fields
 12 ```conf
 13 plugin {
 14   hy3 {
 15     # disable gaps when only one window is onscreen
 16-    no_gaps_when_only = <bool>
 17+    no_gaps_when_only = <bool> # default: false
 18 
 19     # policy controlling what happens when a node is removed from a group,
 20     # leaving only a group
 21     # 0 = remove the nested group
 22     # 1 = keep the nested group
 23-    # 2 = keep the nested group only if its parent is a tab group (default)
 24-    node_collapse_policy = <int>
 25+    # 2 = keep the nested group only if its parent is a tab group
 26+    node_collapse_policy = <int> # default: 2
 27 
 28     # offset from group split direction when only one window is in a group
 29-    group_inset = <int>
 30+    group_inset = <int> # default: 10
 31 
 32     # tab group settings
 33     tabs {
 34       # height of the tab bar
 35-      height = <int>
 36+      height = <int> # default: 15
 37 
 38       # padding between the tab bar and its focused node
 39-      padding = <int>
 40+      padding = <int> # default: 5
 41 
 42       # the tab bar should animate in/out from the top instead of below the window
 43-      from_top = <bool>
 44-
 45-      # render the window title on the bar
 46-      render_text = <bool>
 47+      from_top = <bool> # default: false
 48 
 49       # rounding of tab bar corners
 50-      rounding = <int>
 51+      rounding = <int> # default: 3
 52+
 53+      # render the window title on the bar
 54+      render_text = <bool> # default: true
 55 
 56       # font to render the window title with
 57-      text_font = <string>
 58+      text_font = <string> # default: Sans
 59 
 60       # height of the window title
 61-      text_height = <int>
 62+      text_height = <int> # default: 8
 63 
 64       # left padding of the window title
 65-      text_padding = <int>
 66+      text_padding = <int> # default: 3
 67 
 68       # active tab bar segment color
 69-      col.active = <color>
 70+      col.active = <color> # default: 0xff32b4ff
 71 
 72       # urgent tab bar segment color
 73-      col.urgent = <color>
 74+      col.urgent = <color> # default: 0xffff4f4f
 75 
 76       # inactive tab bar segment color
 77-      col.inactive = <color>
 78+      col.inactive = <color> # default: 0x80808080
 79 
 80       # active tab bar text color
 81-      col.text.active = <color>
 82+      col.text.active = <color> # default: 0xff000000
 83 
 84       # urgent tab bar text color
 85-      col.text.urgent = <color>
 86+      col.text.urgent = <color> # default: 0xff000000
 87 
 88       # inactive tab bar text color
 89-      col.text.inactive = <color>
 90+      col.text.inactive = <color> # default: 0xff000000
 91     }
 92 
 93     # autotiling settings
 94     autotile {
 95       # enable autotile
 96-      enable = <bool>
 97+      enable = <bool> # default: false
 98 
 99       # make autotile-created groups ephemeral
100-      ephemeral_groups = <bool>
101+      ephemeral_groups = <bool> # default: true
102 
103       # if a window would be squished smaller than this width, a vertical split will be created
104       # -1 = never automatically split vertically