From 8a65611cfc53ef9b0024f0248c3a5d23ddd06d46 Mon Sep 17 00:00:00 2001 From: Alexis Jhon Gaspar Date: Thu, 26 Oct 2023 20:40:10 +0800 Subject: [PATCH] Organize the script directory, and add README.md in the script directory as well. --- scripts/README.md | 86 +++++++++++++++++++++++++++++++++++++++ scripts/spmenu/layoutmenu | 37 ----------------- 2 files changed, 86 insertions(+), 37 deletions(-) create mode 100644 scripts/README.md delete mode 100755 scripts/spmenu/layoutmenu diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..83ec770 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,86 @@ +# Scripts + +Scripts designed for `suckless-utils` that either I personally include or written by myself. + +## spmenu + +- `clipmenu-spmenu` - port of clipmenu to spmenu. +- `pirokit-spmenu` - port of Pirokit (1337.to search utility) to spmenu. +- `screenshot-spmenu` - basic screenshot utility using spmenu. +- `wallpaper-spmenu` - basic wallpaper setting utility. +- `spboard` - port of `dboard` to spmenu. + +## dmenu + +- `dboard` - Emoji/copypasta/unicode grabber tool, just put which one then you paste it into your favorite program. +- `shutdown.sh` - Shutdown menu using dmenu. + +## shmenu + +- `shmenu_path` && `shmenu_run` - rough ports of the dmenu counterpart to shmenu. + +## jgmenu + +- `layoutmenu` - Enhanced version of the script from the `layoutmenu` patch in `dwm`. Is included by default in the `config.mk` file of dwm. +- `shutdown` - Shutdown menu using jgmenu, with few added options. + +## dunst + +- `notify-vol-send` - Backend responsible to the included `volume-dunst` script. +- `volume-dunst` - A volume indicator designed for dunst. Loosely based on [this script](https://gist.github.com/sebastiencs/5d7227f388d93374cebdf72e783fbd6a). + +## dwmblocks-async + +Aside from a few modified, it is the same scripts as the ones included in `dwmblocks-async` by default. + +## eww + +- `eww-album`, `eww-artist`, and `eww-music` - Scripts handling fetching music metadata to the `eww` widget in `../config/eww`. +- `messages.txt` and `quoter` - Generate random quotes to be displayed on the `eww` widget. `messages.txt` should be modified and put in `$HOME` or modify the `quoter` script. + +## Ones I personally wrote +### `adelle-theme` + +Bash script that handles setting themes, wallpapers and colorschemes using `pywal`. It also supports grabbing theme from online sources, albeit currently primitive. + +Future plans include parsing repos of themes, allowing users to pick and choose colorschemes from any contributor in the repo, ala a package manager. + +Usage: + +``` +h or help: Prints this text +s or set: Set the colorscheme +sw or setwall: Set the wallpaper +d or download: Download themes to the theme directory +c or clear: Clear the theme directory +l or license: View the GNU General Public License Version 3. +q or quit: Quit the program +``` + +### `tabb` + +`tabb` is a `tabbed` handler script that only does one thing: reparent or attach any windows open (even new ones) to `tabbed`. + +This is designed so that any window manager aside from `dwm` could have tabbed layouts, similar to `i3`, `sway` or `(not)ion`. + +The name originates from `tabc`, which does exactly the same (with few features not implemented in `tabb`), a handler designed around bspwm. I originally designed this as a daemon of sorts, but for now I thought it's a bit immature to call it a daemon, so I called it `tabb` instead (pronounced either tab-bee or just tab). + +Usage: + + +By default, tabb would have auto-reparenting; i.e attach all windows, except for other tabbed sessions automatically. + +I designed tabb so that you could disable the behavior. + +``` +Flags: + +-e: Enable auto-reparenting behavior, i.e attach all windows, except for other tabbed sessions automatically. +-d: Disable auto-reparenting behavior, attach all windows, except for other tabbed sessions automatically but don't reparent new ones. +``` + +In my build of `dwm-flexipatch`, ⊞ Win/⌘ Cmd/❖ Super+Y would execute `tabb -e`, while ⊞ Win/⌘ Cmd/❖ Super+Shift+Y would execute `tabb -d`. + +By design, `tabb` would automatically reparent new windows to a new `tabbed` session, while leaving windows in the old `tabbed` session intact. + +For it to work as intended, I personally recommend using my modified build of `tabbed-flexipatch` or `tabbed-hjc` as `tabb` lacks some functions aside from it's main purpose. diff --git a/scripts/spmenu/layoutmenu b/scripts/spmenu/layoutmenu deleted file mode 100755 index 3a28c60..0000000 --- a/scripts/spmenu/layoutmenu +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/sh -# This simple script uses dmenu to ask the user what they wanna do. - -USER_OPT1=$(printf "[]= (Flextile) Tiled\n><> (Flextile) Floating\n[M] (Flextile) Monocle\n||| (Flextile) Columns\n>M> (Flextile) Floating Master\n[D] (Flextile) Deck\nTTT (Flextile) Bottom Stack\n=== (Flextile) Bottom Stack Horizontal\n|M| (Flextile) Centered Naster\n-M- (Flextile) Centered Master Horizontal\n::: (Flextile) Gapless Grid\n[\\] (Flextile) Fibonacci Dwindle\n(@) (Flextile) Fibonacci Spiral\n[T] (Flextile) Tatami Tats\n[]= Tiled\n[M] Monocle\nTTT Bottom Stack\n=== Bottom Stack Horizontal\n|M| Centered Master\n>M> Centered Floating Master\n||| Columns\n[D] Deck\n(@) Fibonacci Spiral\n[\\] Fibonacci Dwindle\nHHH Grid\n--- Horizontal Grid\n::: Gapless Grid\n### N-row Grid" | spmenu -l 10 -g 1 -p "[?] Layout?") - - -case "$USER_OPT1" in -"[]= (Flextile) Tiled") dwm-msg run_command setlayoutsafe 4313472 ;; -"><> (Flextile) Floating") dwm-msg run_command setlayoutsafe 4313520 ;; -"[M] (Flextile) Monocle") dwm-msg run_command setlayoutsafe 4313568 ;; -"||| (Flextile) Columns") dwm-msg run_command setlayoutsafe 4313616 ;; -">M> (Flextile) Floating Master") dwm-msg run_command setlayoutsafe 4313664 ;; -"[D] (Flextile) Deck") dwm-msg run_command setlayoutsafe 4313712 ;; -"TTT (Flextile) Bottom Stack") dwm-msg run_command setlayoutsafe 4313760 ;; -"=== (Flextile) Bottom Stack Horizontal") dwm-msg run_command setlayoutsafe 4313808 ;; -"|M| (Flextile) Centered Naster") dwm-msg run_command setlayoutsafe 4313856 ;; -"-M- (Flextile) Centered Master Horizontal") dwm-msg run_command setlayoutsafe 4313904 ;; -"::: (Flextile) Gapless Grid") dwm-msg run_command setlayoutsafe 4313952 ;; -"[\] (Flextile) Fibonacci Dwindle") dwm-msg run_command setlayoutsafe 4314000 ;; -"(@) (Flextile) Fibonacci Spiral") dwm-msg run_command setlayoutsafe 4314048 ;; -"[T] (Flextile) Tatami Tats") dwm-msg run_command setlayoutsafe 4314096 ;; -"[]= Tiled") dwm-msg run_command setlayoutsafe 4314144 ;; -"[M] Monocle") dwm-msg run_command setlayoutsafe 4314192 ;; -"TTT Bottom Stack") dwm-msg run_command setlayoutsafe 4314240 ;; -"=== Bottom Stack Horizontal") dwm-msg run_command setlayoutsafe 4314288 ;; -"|M| Centered Master") dwm-msg run_command setlayoutsafe 4314336 ;; -">M> Centered Floating Master") dwm-msg run_command setlayoutsafe 4314384 ;; -"||| Columns") dwm-msg run_command setlayoutsafe 4314432 ;; -"[D] Deck") dwm-msg run_command setlayoutsafe 4314480 ;; -"(@) Fibonacci Spiral") dwm-msg run_command setlayoutsafe 4314528 ;; -"[\] Fibonacci Dwindle") dwm-msg run_command setlayoutsafe 4314576 ;; -"HHH Grid") dwm-msg run_command setlayoutsafe 4314624 ;; -"--- Horizontal Grid") dwm-msg run_command setlayoutsafe 4314672 ;; -"::: Gapless Grid") dwm-msg run_command setlayoutsafe 4314720 ;; -"### N-row Grid") dwm-msg run_command setlayoutsafe 4314768 ;; -"") exit 0 ;; -esac