Warning for WM patches, full sample config

2 files changed, 57 insertions, 42 deletions

diff --git a/picom.sample.conf b/picom.sample.conf
index e980c2d..aed9f83 100644
--- a/picom.sample.conf
+++ b/picom.sample.conf
@@ -48,6 +48,27 @@ animation-for-unmap-window = "zoom";
 #   "class_g = 'Dunst'"
 # ];
 
+#################################
+#           Corners             #
+#################################
+
+# Adjusts the window corner rounding in pixels.
+corner-radius = 14;
+
+# Explicitly declare the corner-radius of individual windows.
+#
+# corners-rule = [
+#   "20:class_g    = 'Polybar'",
+#   "15:class_g    = 'Dunst'",
+# ];
+
+# Exclude conditions for rounded corners.
+#
+# rounded-corners-exclude = [
+#   "window_type = 'dock'",
+#   "class_g = 'bar'"
+# ];
+
 
 #################################
 #             Shadows           #
@@ -59,11 +80,11 @@ animation-for-unmap-window = "zoom";
 #
 shadow = true;
 
-# The blur radius for shadows, in pixels. (defaults to 12)
+# The blur radius for shadows, in pixels. (defaults to 16)
 shadow-radius = 16;
 
 # The opacity of shadows. (0.0 - 1.0, defaults to 0.75)
-# shadow-opacity = .75
+# shadow-opacity = 0.75;
 
 # The left offset for shadows, in pixels. (defaults to -15)
 shadow-offset-x = -15;
@@ -72,16 +93,16 @@ shadow-offset-x = -15;
 shadow-offset-y = -15;
 
 # Red color value of shadow (0.0 - 1.0, defaults to 0).
-# shadow-red = 0
+# shadow-red = 0;
 
 # Green color value of shadow (0.0 - 1.0, defaults to 0).
-# shadow-green = 0
+# shadow-green = 0;
 
 # Blue color value of shadow (0.0 - 1.0, defaults to 0).
-# shadow-blue = 0
+# shadow-blue = 0;
 
 # Hex string color value of shadow (#000000 - #FFFFFF, defaults to #000000). This option will override options set shadow-(red/green/blue)
-# shadow-color = "#000000"
+# shadow-color = "#000000";
 
 # Specify a list of conditions of windows that should have no shadow.
 
@@ -89,9 +110,6 @@ shadow-offset-y = -15;
 #   "class_g = 'change-me'",
 # ];
 
-# Specify a list of conditions of windows that should have no shadow painted over, such as a dock window.
-# clip-shadow-above = []
-
 #################################
 #           Fading              #
 #################################
@@ -102,14 +120,17 @@ shadow-offset-y = -15;
 # FADING IS REQUIRED FOR CLOSING ANIMATIONS
 fading = true;
 
-#
-# CHANGING FADING SETTINGS MAKE A BIG DIFFERENCE TO HOW ANIMATIONS APPEAR. ITS NOT RECCOMENDED TO CHANGE FADE SETTINGS.
-#
-
 # Opacity change between steps while fading in. (0.01 - 1.0, defaults to 0.03)
+#
+# Increasing this value will result in faster fading in of windows. 
+# Decreasing makes the fading in of windows take longer. 
+# (This does not means the animations take longer, just the fading).
 fade-in-step = 0.03;
 
 # Opacity change between steps while fading out. (0.01 - 1.0, defaults to 0.03)
+#
+# Increasing this value will result in faster fading out AND animating out of windows. 
+# Decreasing this makes fading and animating out take longer.
 fade-out-step = 0.03;
 
 # The time between steps in fade step, in milliseconds. (> 0, defaults to 10)
@@ -136,18 +157,17 @@ inactive-opacity = 1.0;
 # Opacity of window titlebars and borders. (0.1 - 1.0, disabled by default)
 frame-opacity = 1.0;
 
-# Overries any opacities set in `opacity-rule`
+# Overrides any opacities set in `opacity-rule` when set to true.
 inactive-opacity-override = false;
 
 # Default opacity for active windows. (0.0 - 1.0, defaults to 1.0)
-active-opacity = 1.0
+active-opacity = 1.0;
 
 # Dim inactive windows. (0.0 - 1.0, defaults to 0.0)
-# inactive-dim = 0.0
-
+# inactive-dim = 0.0;
 
 # A list of windows that should have their inactive-opacity set to whatever the active-opacity is. 
-# Unless the window is also in active-opacity-exclude then it will be set to 1.0 or if it is set in "opacity-rule", 
+# Unless the window is also in active-exclude then it will be set to 1.0 or if it is set in "opacity-rule", 
 # it will use the opacity set there as the inactive-opacity
 # Also excludes effects caused by inactive-dim
 #
@@ -167,23 +187,7 @@ active-opacity = 1.0
 # like `50:name *= "Firefox"`.
 
 # opacity-rule = [
-
-# ];
-
-
-#################################
-#           Corners             #
-#################################
-
-# Sets the radius of rounded window corners. When > 0, the compositor will
-# round the corners of windows.
-corner-radius = 14;
-
-# Exclude conditions for rounded corners.
-
-# rounded-corners-exclude = [
-#   "window_type = 'dock'",
-#   "window_type = 'desktop'"
+#   "80:class_g = 'Alacritty'"
 # ];
 
 
@@ -191,6 +195,9 @@ corner-radius = 14;
 #     Background-Blurring       #
 #################################
 
+# Blur background of windows.
+#
+blur-background = true;
 
 # Parameters for background blurring, see the *BLUR* section for more information.
 blur-method = "dual_kawase";
@@ -203,16 +210,11 @@ blur-strength = 5;
 
 # Blur kernel preset. Play around and see what looks best.
 # Options "3x3box", "5x5box", "7x7box", "3x3gaussian", "5x5gaussian", "7x7gaussian", "9x9gaussian", "11x11gaussian"
-# blur-kern = "3x3box"
-
-# Blur background of semi-transparent / ARGB windows.
-# Bad in performance, with driver-dependent behavior.
-# The name of the switch may change without prior notifications.
 #
-blur-background = true;
+# blur-kern = "3x3box";
 
 # Toggle whether you want to use a blacklist or whitelist.
-
+# Defaults to "true"
 blur-whitelist = true;
 
 # Whitelist for windows to have background blurring
@@ -221,6 +223,13 @@ blur-include = [
   "class_g = 'kitty'"
 ];
 
+# Blacklist for background blurring. 
+# Only works if "blur-whitelist = false;"
+#
+# blur-exclude = [
+#   "class_g = 'Firefox'"
+# ];
+
 #################################
 #       General Settings        #
 #################################
diff --git a/src/config_libconfig.c b/src/config_libconfig.c
index ac4eb96..523dc91 100644
--- a/src/config_libconfig.c
+++ b/src/config_libconfig.c
@@ -520,6 +520,12 @@ char *parse_config_libconfig(options_t *opt, const char *config_file, bool *shad
 	parse_cfg_condlst(&cfg, &opt->shadow_clip_list, "clip-shadow-above");
 	// --fade-exclude
 	parse_cfg_condlst(&cfg, &opt->fade_blacklist, "fade-exclude");
+
+	log_warn("If you are using AwesomeWM, DWM or Herbstluftwm please set this option in your config\n"
+			 "\n"
+			 "wm-support = 'awesome'\n"
+			 "# Avaliable options are, 'awesome', 'herb', 'dwm'\n");
+
 	// --animations
 	lcfg_lookup_bool(&cfg, "animations", &opt->animations);
 	// --animation-for-open-window