New Setup 📦

home/.config/awesome/libs/bling/docs/module/flash.md

@@ -0,0 +1,33 @@
+## 🔦 Flash Focus <!-- {docsify-ignore} -->
+
+Flash focus does an opacity animation effect on a client when it is focused.
+
+
+### Usage
+
+There are two ways in which you can use this module. You can enable it by calling the `enable()` function:
+```lua
+bling.module.flash_focus.enable()
+```
+This connects to the focus signal of a client, which means that the flash focus will activate however you focus the client.
+
+The other way is to call the function itself like this: `bling.module.flash_focus.flashfocus(someclient)`. This allows you to activate on certain keybinds like so:
+```lua
+awful.key({modkey}, "Up",
+    function()
+        awful.client.focus.bydirection("up")
+        bling.module.flash_focus.flashfocus(client.focus)
+     end, {description = "focus up", group = "client"})
+```
+
+### Theme Variables
+```lua
+theme.flash_focus_start_opacity = 0.6 -- the starting opacity
+theme.flash_focus_step = 0.01         -- the step of animation
+```
+
+### Preview
+
+![](https://imgur.com/5txYrlV.gif)
+
+*gif by [JavaCafe01](https://github.com/JavaCafe01)*

home/.config/awesome/libs/bling/docs/module/scratch.md

@@ -0,0 +1,75 @@
+## 🍃 Scratchpad <!-- {docsify-ignore} -->
+
+An easy way to create multiple scratchpads.
+
+### A... what?
+
+You can think about a scratchpad as a window whose visibility can be toggled, but still runs in the background without being visible (or minimized) most of the time. Many people use it to have one terminal in which to perform minor tasks, but it is the most useful for windows which only need a couple seconds in between your actual activity, such as music players or chat applications.
+
+### Rubato Animation Support
+
+#### Awestore is now deprecated from Bling, we are switching to Rubato.
+
+Please go over to the [rubato](https://github.com/andOrlando/rubato) repository for installation instructions. Give it a star as well! The animations are completely optional, and if you choose not to use it, you do not need rubato installed.
+
+### Usage
+
+To initalize a scratchpad you can do something like the following:
+
+```lua
+local bling = require("bling")
+local rubato = require("rubato") -- Totally optional, only required if you are using animations.
+
+-- These are example rubato tables. You can use one for just y, just x, or both.
+-- The duration and easing is up to you. Please check out the rubato docs to learn more.
+local anim_y = rubato.timed {
+    pos = 1090,
+    rate = 60,
+    easing = rubato.quadratic,
+    intro = 0.1,
+    duration = 0.3,
+    awestore_compat = true -- This option must be set to true.
+}
+
+local anim_x = rubato.timed {
+    pos = -970,
+    rate = 60,
+    easing = rubato.quadratic,
+    intro = 0.1,
+    duration = 0.3,
+    awestore_compat = true -- This option must be set to true.
+}
+
+local term_scratch = bling.module.scratchpad {
+    command = "wezterm start --class spad",           -- How to spawn the scratchpad
+    rule = { instance = "spad" },                     -- The rule that the scratchpad will be searched by
+    sticky = true,                                    -- Whether the scratchpad should be sticky
+    autoclose = true,                                 -- Whether it should hide itself when losing focus
+    floating = true,                                  -- Whether it should be floating (MUST BE TRUE FOR ANIMATIONS)
+    geometry = {x=360, y=90, height=900, width=1200}, -- The geometry in a floating state
+    reapply = true,                                   -- Whether all those properties should be reapplied on every new opening of the scratchpad (MUST BE TRUE FOR ANIMATIONS)
+    dont_focus_before_close  = false,                 -- When set to true, the scratchpad will be closed by the toggle function regardless of whether its focused or not. When set to false, the toggle function will first bring the scratchpad into focus and only close it on a second call
+    rubato = {x = anim_x, y = anim_y}                 -- Optional. This is how you can pass in the rubato tables for animations. If you don't want animations, you can ignore this option.
+}
+```
+
+Once initalized, you can use the object (which in this case is named `term_scratch`) like this:
+
+```lua
+term_scratch:toggle()   -- toggles the scratchpads visibility
+term_scratch:turn_on()  -- turns the scratchpads visibility on
+term_scratch:turn_off() -- turns the scratchpads visibility off
+```
+
+You can also connect to signals as you are used to for further customization. For example like that:
+
+```lua
+term_scratch:connect_signal("turn_on", function(c) naughty.notify({title = "Turned on!"}) end)
+```
+
+The following signals are currently available. `turn_on`, `turn_off` and `inital_apply` pass the client on which they operated as an argument:
+
+- `turn_on` fires when the scratchpad is turned on on a tag that it wasn't present on before
+- `turn_off` fires when the scratchpad is turned off on a tag
+- `spawn` fires when the scratchpad is launched with the given command
+- `inital_apply` fires after `spawn`, when a corresponding client has been found and the properties have been applied

home/.config/awesome/libs/bling/docs/module/swal.md

@@ -0,0 +1,25 @@
+## 😋 Window Swallowing <!-- {docsify-ignore} -->
+
+Can your window manager swallow? It probably can...
+
+### Usage
+
+To activate and deactivate window swallowing here are the following functions. If you want to activate it, just call the `start` function once in your `rc.lua`.
+```lua
+bling.module.window_swallowing.start()  -- activates window swallowing
+bling.module.window_swallowing.stop()   -- deactivates window swallowing
+bling.module.window_swallowing.toggle() -- toggles window swallowing
+```
+
+### Theme Variables
+```lua
+theme.parent_filter_list   = {"firefox", "Gimp"} -- class names list of parents that should not be swallowed
+theme.child_filter_list    = { "Dragon" }        -- class names list that should not swallow their parents
+theme.swallowing_filter = true                   -- whether the filters above should be active
+```
+
+### Preview
+
+![](https://media.discordapp.net/attachments/635625813143978012/769180910683684864/20-10-23-14-40-32.gif)
+
+*gif by [Nooo37](https://github.com/Nooo37)*

home/.config/awesome/libs/bling/docs/module/tabbed.md

@@ -0,0 +1,66 @@
+## 📑 Tabbed <!-- {docsify-ignore} -->
+
+Tabbed implements a tab container. There are also different themes for the tabs.
+
+### Usage
+
+You should bind these functions to keys in order to use the tabbed module effectively:
+```lua
+bling.module.tabbed.pick()                 -- picks a client with your cursor to add to the tabbing group
+bling.module.tabbed.pop()                  -- removes the focused client from the tabbing group
+bling.module.tabbed.iter()            	   -- iterates through the currently focused tabbing group
+bling.module.tabbed.pick_with_dmenu()      -- picks a client with a dmenu application (defaults to rofi, other options can be set with a string parameter like "dmenu")
+bling.module.tabbed.pick_by_direction(dir) -- picks a client based on direction ("up", "down", "left" or "right")
+```
+
+### Theme Variables
+
+```lua
+-- For tabbed only
+theme.tabbed_spawn_in_tab = false  -- whether a new client should spawn into the focused tabbing container
+
+-- For tabbar in general
+theme.tabbar_ontop  = false
+theme.tabbar_radius = 0                -- border radius of the tabbar
+theme.tabbar_style = "default"         -- style of the tabbar ("default", "boxes" or "modern")
+theme.tabbar_font = "Sans 11"          -- font of the tabbar
+theme.tabbar_size = 40                 -- size of the tabbar
+theme.tabbar_position = "top"          -- position of the tabbar
+theme.tabbar_bg_normal = "#000000"     -- background color of the focused client on the tabbar
+theme.tabbar_fg_normal = "#ffffff"     -- foreground color of the focused client on the tabbar
+theme.tabbar_bg_focus  = "#1A2026"     -- background color of unfocused clients on the tabbar
+theme.tabbar_fg_focus  = "#ff0000"     -- foreground color of unfocused clients on the tabbar
+theme.tabbar_bg_focus_inactive = nil   -- background color of the focused client on the tabbar when inactive
+theme.tabbar_fg_focus_inactive = nil   -- foreground color of the focused client on the tabbar when inactive
+theme.tabbar_bg_normal_inactive = nil  -- background color of unfocused clients on the tabbar when inactive
+theme.tabbar_fg_normal_inactive = nil  -- foreground color of unfocused clients on the tabbar when inactive
+theme.tabbar_disable = false           -- disable the tab bar entirely
+
+-- the following variables are currently only for the "modern" tabbar style
+theme.tabbar_color_close = "#f9929b" -- chnges the color of the close button
+theme.tabbar_color_min   = "#fbdf90" -- chnges the color of the minimize button
+theme.tabbar_color_float = "#ccaced" -- chnges the color of the float button
+```
+
+### Preview
+
+Modern theme:
+
+<img src="https://imgur.com/omowmIQ.png" width="600"/>
+
+*screenshot by [JavaCafe01](https://github.com/JavaCafe01)*
+
+### Signals
+The tabbed module emits a few signals for the purpose of integration,
+```lua
+-- bling::tabbed::update -- triggered whenever a tabbed object is updated
+--             tabobj -- the object that caused the update
+-- bling::tabbed::client_added -- triggered whenever a new client is added to a tab group
+--             tabobj -- the object that the client was added to
+--             client -- the client that added
+-- bling::tabbed::client_removed -- triggered whenever a client is removed from a tab group
+--             tabobj -- the object that the client was removed from
+--             client -- the client that was removed
+-- bling::tabbed::changed_focus -- triggered whenever a tab group's focus is changed
+--             tabobj -- the modified tab group
+```

home/.config/awesome/libs/bling/docs/module/twall.md

@@ -0,0 +1,26 @@
+## 🏬 Tiled Wallpaper <!-- {docsify-ignore} -->
+
+### Usage
+
+The function to set an automatically created tiled wallpaper can be called the following way (you don't need to set every option in the table):
+```lua
+awful.screen.connect_for_each_screen(function(s) -- that way the wallpaper is applied to every screen
+    bling.module.tiled_wallpaper("x", s, {       -- call the actual function ("x" is the string that will be tiled)
+        fg = "#ff0000", -- define the foreground color
+        bg = "#00ffff", -- define the background color
+        offset_y = 25,  -- set a y offset
+        offset_x = 25,  -- set a x offset
+        font = "Hack",  -- set the font (without the size)
+        font_size = 14, -- set the font size
+        padding = 100,  -- set padding (default is 100)
+        zickzack = true -- rectangular pattern or criss cross
+    })
+end)
+```
+
+### Preview
+
+![](https://media.discordapp.net/attachments/702548913999314964/773887721294135296/tiled-wallpapers.png?width=1920&height=1080)
+
+*screenshots by [Nooo37](https://github.com/Nooo37)*
+

home/.config/awesome/libs/bling/docs/module/wall.md

@@ -0,0 +1,142 @@
+## 🎇 Wallpaper Easy Setup  <!-- {docsify-ignore} -->
+
+This is a simple-to-use, extensible, declarative wallpaper manager.
+
+### Practical Examples
+
+```lua
+-- A default Awesome wallpaper
+bling.module.wallpaper.setup()
+
+-- A slideshow with pictures from different sources changing every 30 minutes
+bling.module.wallpaper.setup {
+    wallpaper = {"/images/my_dog.jpg", "/images/my_cat.jpg"},
+    change_timer = 1800
+}
+
+-- A random wallpaper with images from multiple folders
+bling.module.wallpaper.setup {
+    set_function = bling.module.wallpaper.setters.random,
+    wallpaper = {"/path/to/a/folder", "/path/to/another/folder"},
+    change_timer = 631, -- prime numbers are better for timers
+    position = "fit",
+    background = "#424242"
+}
+
+-- wallpapers based on a schedule, like awesome-glorious-widgets dynamic wallpaper
+-- https://github.com/manilarome/awesome-glorious-widgets/tree/master/dynamic-wallpaper
+bling.module.wallpaper.setup {
+    set_function = bling.module.wallpaper.setters.simple_schedule,
+    wallpaper = {
+        ["06:22:00"] = "morning-wallpaper.jpg",
+        ["12:00:00"] = "noon-wallpaper.jpg",
+        ["17:58:00"] = "night-wallpaper.jpg",
+        ["24:00:00"] = "midnight-wallpaper.jpg",
+    },
+    position = "maximized",
+}
+
+-- random wallpapers, from different folder depending on time of the day
+bling.module.wallpaper.setup {
+    set_function = bling.module.wallpaper.setters.simple_schedule,
+    wallpaper = {
+        ["09:00:00"] = "~/Pictures/safe_for_work",
+        ["18:00:00"] = "~/Pictures/personal",
+    },
+    schedule_set_function = bling.module.wallpaper.setters.random
+    position = "maximized",
+    recursive = false,
+    change_timer = 600
+}
+
+-- setup for multiple screens at once
+-- the 'screen' argument can be a table of screen objects
+bling.module.wallpaper.setup {
+    set_function = bling.module.wallpaper.setters.random,
+    screen = screen, -- The awesome 'screen' variable is an array of all screen objects
+    wallpaper = {"/path/to/a/folder", "/path/to/another/folder"},
+    change_timer = 631
+}
+```
+### Details
+
+The setup function will do 2 things: call the set-function when awesome requests a wallpaper, and manage a timer to call `set_function` periodically.
+
+Its argument is a args table that is passed to ohter functions (setters and wallpaper functions), so you define everything with setup.
+
+The `set_function` is a function called every times a wallpaper is needed.
+
+The module provides some setters:
+
+* `bling.module.wallpaper.setters.awesome_wallpaper`: beautiful.theme_assets.wallpaper with defaults from beautiful.
+* `bling.module.wallpaper.setters.simple`: slideshow from the `wallpaper` argument.
+* `bling.module.wallpaper.setters.random`: same as simple but in a random way.
+* `bling.module.wallpaper.setters.simple_schedule`: takes a table of `["HH:MM:SS"] = wallpaper` arguments, where wallpaper is the `wallpaper` argument used by `schedule_set_function`.
+
+A wallpaper is one of the following elements:
+
+* a color
+* an image
+* a folder containing images
+* a function that sets a wallpaper
+* everything gears.wallpaper functions can manage (cairo surface, cairo pattern string)
+* a list containing any of the elements above
+
+To set up for multiple screens, two possible methods are:
+* Call the `setup` function for each screen, passing the appropriate configuration and `screen` arg
+* Call the `setup` function once, passing a table of screens as the `screen` arg. This applies the same configuration to all screens in the table
+_Note_: Multiple screen setup only works for the `simple` and `random` setters
+
+```lua
+-- This is a valid wallpaper definition
+bling.module.wallpaper.setup {
+    wallpaper = {                  -- a list
+        "black", "#112233",        -- colors
+        "wall1.jpg", "wall2.png",  -- files
+        "/path/to/wallpapers",     -- folders
+        -- cairo patterns
+        "radial:600,50,100:105,550,900:0,#2200ff:0.5,#00ff00:1,#101010",
+        -- or functions that set a wallpaper
+        function(args) bling.module.tiled_wallpaper("\\o/", args.screen) end,
+        bling.module.wallpaper.setters.awesome_wallpaper,
+    },
+    change_timer = 10,
+}
+```
+The provided setters `simple` and `random` will use 2 internal functions that you can use to write your own setter:
+
+* `bling.module.wallpaper.prepare_list`: return a list of wallpapers directly usable by `apply` (for now, it just explores folders)
+* `bling.module.wallpaper.apply`: a wrapper for gears.wallpaper functions, using the args table of setup
+
+Here are the defaults:
+
+```lua
+-- Default parameters
+bling.module.wallpaper.setup {
+    screen = nil,       -- the screen to apply the wallpaper, as seen in gears.wallpaper functions
+    screens = nil,      -- an array of screens to apply the wallpaper on. If 'screen' is also provided, this is overridden
+    change_timer = nil, -- the timer in seconds. If set, call the set_function every change_timer seconds
+    set_function = nil, -- the setter function
+
+    -- parameters used by bling.module.wallpaper.prepare_list
+    wallpaper = nil,                               -- the wallpaper object, see simple or simple_schedule documentation
+    image_formats = {"jpg", "jpeg", "png", "bmp"}, -- when searching in folder, consider these files only
+    recursive = true,                              -- when searching in folder, search also in subfolders
+
+    -- parameters used by bling.module.wallpaper.apply
+    position = nil,                              -- use a function of gears.wallpaper when applicable ("centered", "fit", "maximized", "tiled")
+    background = beautiful.bg_normal or "black", -- see gears.wallpaper functions
+    ignore_aspect = false,                       -- see gears.wallpaper.maximized
+    offset = {x = 0, y = 0},                     -- see gears.wallpaper functions
+    scale = 1,                                   -- see gears.wallpaper.centered
+
+    -- parameters that only apply to bling.module.wallpaper.setter.awesome (as a setter or as a wallpaper function)
+    colors = {                   -- see beautiful.theme_assets.wallpaper
+        bg = beautiful.bg_color,  -- the actual default is this color but darkened or lightned
+        fg = beautiful.fg_color,
+        alt_fg = beautiful.fg_focus
+    }
+}
+```
+
+Check documentation in [module/wallpaper.lua](module/wallpaper.lua) for more details.