added documentation for custom hyprland controls

2024-11-07 15:31:34 -05:00
parent da191e5ae4
commit 2127996ee8
4 changed files with 264 additions and 217 deletions
--- a/docs/options/home_options.md
+++ b/docs/options/home_options.md
@@ -1,235 +1,235 @@
 # Home-Manager Options

 ## homeFiles.enable
-	- Enables my declared files
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/files/neofetch.nix'
+  - Enables my declared files
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/files/neofetch.nix'

 ## hyprlandConfig.enable
-	- Enables my custom hyprland configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/hyprland.nix'
+  - Enables my custom hyprland configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/hyprland.nix'

 ## autojumpConfig.enable
-	- Enables my autojump options
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/autojump.nix'
+  - Enables my autojump options
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/autojump.nix'

 ## stylixHomeConfig.enable
-	- Enables my stylix home-manager options
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/stylix.nix'
+  - Enables my stylix home-manager options
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/stylix.nix'

 ## waybarConfig.enable
-	- Enables my custom waybar configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/waybar.nix'
+  - Enables my custom waybar configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/waybar.nix'

 ## gtkConfig.enable
-	- Enables my gtk configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/gtk.nix'
+  - Enables my gtk configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/gtk.nix'

 ## spicetifyConfig.enable
-	- Enables my spicetify configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/spicetify.nix'
+  - Enables my spicetify configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/spicetify.nix'

 ## starshipConfig.enable
-	- Enables my starship configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/starship.nix'
+  - Enables my starship configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/starship.nix'

 ## btopConfig.enable
-	- Enables my btop configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/btop.nix'
+  - Enables my btop configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/btop.nix'

 ## swayncConfig.enable
-	- Enables my swaync configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/swaync.nix'
+  - Enables my swaync configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/swaync.nix'

 ## userPkgs.enable
-	- Enables my default user packages
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/userpkgs.nix'
+  - Enables my default user packages
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/userpkgs.nix'

 ## cavaConfig.enable
-	- Enables my cava configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/cava.nix'
+  - Enables my cava configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/cava.nix'

 ## ezaConfig.enable
-	- Enables my eza configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/eza.nix'
+  - Enables my eza configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/eza.nix'

 ## firefoxConfig.enable
-	- Enables my firefox configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/firefox.nix'
+  - Enables my firefox configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/firefox.nix'

 ## fuzzelConfig.enable
-	- Enables my fuzzel configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/fuzzel.nix'
+  - Enables my fuzzel configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/fuzzel.nix'

 ## fzfConfig.enable
-	- Enables my fzf configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/fzf.nix'
+  - Enables my fzf configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/fzf.nix'

 ## gitConfig.enable
-	- Enables my git configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/git.nix'
+  - Enables my git configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/git.nix'

 ## kittyConfig.enable
-	- Enables my kitty configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/kitty.nix'
+  - Enables my kitty configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/kitty.nix'

 ## yaziConfig.enable
-	- Enables my yazi configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/yazi.nix'
+  - Enables my yazi configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/yazi.nix'

 ## zshConfig.enable
-	- Enables my zsh configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/environment/zshell.nix'
+  - Enables my zsh configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/environment/zshell.nix'

 ## passConfig.enable
-	- Enables my password-store configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/password-store.nix'
+  - Enables my password-store configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/password-store.nix'

 ## batConfig.enable
-	- Enables my bat configuration
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/programs/bat.nix'
+  - Enables my bat configuration
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/programs/bat.nix'

 ## movScripts.enable
-	- Enables my custom script binaries
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables my custom script binaries
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'

 ## movScripts.commandScripts
 ### enable
-	- Enables my custom command scripts
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables my custom command scripts
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### invoke.enable
-	- Enables the invoke command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the invoke command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### runbg.enable
-	- Enables the runbg command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the runbg command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### splash.enable
-	- Enables the splash command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the splash command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### toolbelt.enable
-	- Enables the toolbelt command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the toolbelt command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### viconf.enable
-	- Enables the viconf command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the viconf command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'

 ## movScripts.hyprlandControls
 ### enable
-	- Enables my hyprland control shortcut scripts
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables my hyprland control shortcut scripts
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### chpaper.enable
-	- Enables the chpaper command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the chpaper command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### scheck.enable
-	- Enables the scheck command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the scheck command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### chscheme.enable
-	- Enables the chscheme command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the chscheme command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### keyring.enable
-	- Enables the keyring command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the keyring command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### moveonscreen.enable
-	- Enables the moveonscreen command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the moveonscreen command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### switchmon.enable
-	- Enables the switchmon command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the switchmon command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### mkscreenshots.enable
-	- Enables the mkscreenshots command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the mkscreenshots command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'

 ## movScripts.nixShortcuts
 ### enable
-	- Enables my NixOS aliases
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables my NixOS aliases
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### garbage-collect.enable
-	- Enables the garbage-collect command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the garbage-collect command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### nsp.enable
-	- Enables the nsp command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the nsp command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
 ### rebuild.enable
-	- Enables the rebuild command
-	- Type: Boolean
-	- Default: true
-	- Defined in 'modules/home/scripts/default.nix'
+  - Enables the rebuild command
+  - Type: Boolean
+  - Default: true
+  - Defined in 'modules/home/scripts/default.nix'
--- a/docs/options/system_options.md
+++ b/docs/options/system_options.md
@@ -1,79 +1,79 @@
 # System Options

 ## networkModule.enable
-	- Enables my network configuration
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/hardware/network.nix'
+  - Enables my network configuration
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/hardware/network.nix'

 ## nixSettings.enable
-	- Enables my NixOS settings
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/environment/nix.nix'
+  - Enables my NixOS settings
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/environment/nix.nix'

 ## bootLoader.enable
-	- Enables my bootloader settings
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/hardware/bootloader.nix'
+  - Enables my bootloader settings
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/hardware/bootloader.nix'

 ## issue.enable
-	- Enables my custom /etc/issue tty splash screen
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/environment/issue.nix'
+  - Enables my custom /etc/issue tty splash screen
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/environment/issue.nix'

 ## sddmConfig.enable
-	- Enables my catppuccin-sddm configuration
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/environment/sddm.nix'
+  - Enables my catppuccin-sddm configuration
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/environment/sddm.nix'

 ## stylixConfig.enable
-	- Enables stylix for system theming
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/environment/stylix.nix'
+  - Enables stylix for system theming
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/environment/stylix.nix'

 ## gamingPkgs.enable
-	- Enables gaming-related packages
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/gaming/gaming_pkgs.nix'
+  - Enables gaming-related packages
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/gaming/gaming_pkgs.nix'

 ## steamConfig.enable
-	- Enables my Steam configuration
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/gaming/steam.nix'
+  - Enables my Steam configuration
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/gaming/steam.nix'

 ## sysPkgs.enable
-	- Installs my default system packages
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/packages.nix'
+  - Installs my default system packages
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/packages.nix'

 ## sysProgs.enable
-	- Enables
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/programs.nix'
+  - Enables
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/programs.nix'

 ## sysServices.enable
-	- Description
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/services.nix'
+  - Description
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/services.nix'

 ## virtConfig.enable
-	- Description
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/software/virtualization.nix'
+  - Description
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/software/virtualization.nix'

 ## powerProfiles.enable
-	- Description
-	- Type: Boolean
-	- Default: false
-	- Defined in 'modules/sys/hardware/powerprofiles.nix'
+  - Description
+  - Type: Boolean
+  - Default: false
+  - Defined in 'modules/sys/hardware/powerprofiles.nix'
--- a/docs/scripts/nixshortcuts.md
+++ b/docs/scripts/nixshortcuts.md
@@ -1,7 +1,7 @@
 # pagedMov's Nix Aliases

 ## fetchfromgh
-  - Given a username and repo name like someuser/somerepo, generates a full pkgs.fetchFromGitHub call.
+  - Given a username and repo name like someuser/somerepo, generates a full pkgs.fetchFromGitHub call. Uses the most recent commit.
  - Usage:
    - `fetchfromgh someuser/somerepo`
  - Example:
--- a/docs/scripts/wmcontrols.md
+++ b/docs/scripts/wmcontrols.md
@@ -0,0 +1,47 @@
+# Custom Hyprland Controls
+
+None of these are meant to be invoked directly in the terminal and are mainly used as helpers for my other scripts. I will
+still document them in case you wish to use them in your own scripts.
+
+## chscheme
+  - Opens a fzf menu containing all of the color schemes contained in the base16schemes package in nixpkgs. The fzf preview contains the colors so you can see them in your terminal before you choose them.
+  - Usage:
+    - `chscheme` - Does not take arguments.
+  - Defined in 'modules/home/scripts/wm-controls/chscheme.nix'
+
+## chpaper
+  - Opens a fzf menu containing all of the wallpapers held in $FLAKEPATH/assets/wallpapers. The fzf preview shows the image file that the user is hovering over.
+  - Usage:
+    - `chpaper` - Does not take arguments.
+  - Defined in 'modules/home/scripts/wm-controls/chpaper.nix'
+
+## keyring
+  - Opens a fzf menu containing all of the directories/files contained in ~/.password-store. Selecting one uses `pass -c` to copy it to the clipboard. The script pauses the clipboard history daemon while it does this so that the password is not added to your clipboard history. If anyone can think of a more secure way to do this, let me know. Password is cleared from the clipboard automatically after 10 seconds if not overwritten by something else.
+  - Usage:
+    - `keyring` - Does not take arguments.
+  - Defined in 'modules/home/scripts/wm-controls/keyring.nix'
+
+## mkscreenshots
+  - If workspace 4 is empty, switches to that workspace and takes some screenshots that showcase the desktop environment. These screenshots are then saved to $FLAKEPATH/assets/screens, overwriting the old ones. README.md is then updated to include the commit that the screenshots were taken on.
+  - Usage:
+    - `mkscreenshots` - Does not take arguments. Only runs if workspace 4 has no windows.
+  - Defined in 'modules/home/scripts/wm-controls/mkscreenshots.nix'
+
+## moveonscreen
+  - Uses hyprctl to move the currently active window, if it is floating. The window moves relative to the cursor, and will not move past the bounds of the screen. Used by toolbelt to produce the cool window movements.
+  - Usage:
+    - `moveonscreen` - Moves the window to the cursor's position, anchored at the top-left corner. Does not leave the bounds of the screen.
+    - `moveonscreen --center` - Behaves the same way, except anchors at the center of the window instead of the top-left corner.
+  - Defined in 'modules/home/scripts/wm-controls/moveonscreen.nix'
+
+## s_check
+  - A simple test invocation checking to see if $SOUNDS_ENABLED is 0 or 1. Don't ask why this doesn't work as a zsh alias, because it doesn't for some reason and I don't really know why. Does not return anything except for the status code from the test.
+  - Usage:
+    - `s_check` - Does not take arguments.
+  - Defined in 'modules/home/scripts/wm-controls/switchmon.nix'
+
+## switchmon
+  - Uses hyprctl to switch the focused monitor to the other monitor. Currently only supports setups with two monitors.
+  - Usage:
+    - `switchmon` - Does not take arguments.
+  - Defined in 'modules/home/scripts/wm-controls/switchmon.nix'