From 88f2740361a64b3c7d230f3c6745556cbc494643 Mon Sep 17 00:00:00 2001 From: SirBlobby Date: Mon, 27 Jul 2026 12:31:01 -0400 Subject: [PATCH] Extract commands.md from README, link wallpaper/keybinds/commands docs --- README.md | 19 +++++++------------ commands.md | 12 ++++++++++++ 2 files changed, 19 insertions(+), 12 deletions(-) create mode 100644 commands.md diff --git a/README.md b/README.md index 966da83..0a04ec7 100644 --- a/README.md +++ b/README.md @@ -21,24 +21,19 @@ My current setup is built around these core components: ### Directory Structure -- **`hypr/`**: Hyprland configurations (keybindings, window rules, animations, monitor layout, lid-close display handling, and autostart). +- **`hypr/`**: Hyprland configurations (keybindings, window rules, animations, monitor layout, lid-close display handling, and autostart). See [`hypr/keybinds.md`](hypr/keybinds.md) for custom keybindings. - **`waybar/`**: Status bar layout, CSS styling, and custom interactive modules. - **`ags/`**: Custom desktop widgets built with TypeScript and GTK — media player, notification hub, quick settings, system monitor, and wallpaper picker. -- **`scripts/`**: Global utility scripts seamlessly exposed as commands by the installer. -- **`wallpapers/`**: A collection of local custom wallpapers for dynamic theming. +- **`scripts/`**: Global utility scripts seamlessly exposed as commands by the installer. See [`commands.md`](commands.md). +- **`wallpapers/`**: A collection of local custom wallpapers for dynamic theming. See [`wallpaper.md`](wallpaper.md) for the full gallery. - **`omarchy/hooks/`**: Event hooks for the Omarchy system (e.g. automatically applying dynamic themes when changing wallpapers). - **`branding/`**: Custom ASCII art and system branding assets. -## Custom Commands +## Docs -The installer automatically exposes scripts from the `scripts/` directory as global commands: - -- **`blob_wallpaper [path]`**: Sets your background using Omarchy's background system. If used with an image from `~/wallpapers/` or a valid path, it leverages Pywal to generate a full system color palette and dynamically updates the `blob-dynamic` theme, AGS widgets, and Waybar. -- **`blob_theme `**: Pulls a color palette shared from the wall-styles site and applies it as the `blob-dynamic` theme (e.g. `blob_theme "https://wall-styles.vercel.app/?id=ab12cd34ef"`). -- **`blob_glass [on|off|toggle]`**: A quick toggle to enable or disable window transparency on the fly. -- **`blob_boot [path]`**: Safely updates your Plymouth boot splash image (defaults to `branding/boot_flash.png`) and rebuilds the `initramfs` (GRUB compatible via `mkinitcpio`). -- **`blob_wifi`**: A streamlined script to connect to the GMU Eduroam Wi-Fi network using `iwd` and `systemd-resolved` (replaces NetworkManager). -- **`blob_key [NAME] [VALUE]`**: Stores secrets/env values for widgets and services, e.g. `blob_key set SOME_TOKEN value`. +- [Wallpaper Gallery](wallpaper.md) — preview of every wallpaper in `wallpapers/`. +- [Keybinds](hypr/keybinds.md) — custom Hyprland keybindings on top of Omarchy's defaults. +- [Commands](commands.md) — custom `blob_*` CLI commands exposed by the installer. ## Installation diff --git a/commands.md b/commands.md new file mode 100644 index 0000000..aa99955 --- /dev/null +++ b/commands.md @@ -0,0 +1,12 @@ +# Custom Commands + +The installer automatically exposes scripts from [`scripts/`](scripts/) as global commands. + +| Command | Description | +| --- | --- | +| `blob_wallpaper [path]` | Sets your background using Omarchy's background system. If used with an image from `~/wallpapers/` or a valid path, it leverages Pywal to generate a full system color palette and dynamically updates the `blob-dynamic` theme, AGS widgets, and Waybar. With no argument, it opens the AGS wallpaper picker. | +| `blob_theme ` | Pulls a color palette shared from the wall-styles site and applies it as the `blob-dynamic` theme (e.g. `blob_theme "https://wall-styles.vercel.app/?id=ab12cd34ef"`). | +| `blob_glass [on\|off\|toggle]` | A quick toggle to enable or disable window transparency on the fly. | +| `blob_boot [path]` | Safely updates your Plymouth boot splash image (defaults to `branding/boot_flash.png`) and rebuilds the `initramfs` (GRUB compatible via `mkinitcpio`). | +| `blob_wifi` | A streamlined script to connect to the GMU Eduroam Wi-Fi network using `iwd` and `systemd-resolved` (replaces NetworkManager). | +| `blob_key [NAME] [VALUE]` | Stores secrets/env values for widgets and services, e.g. `blob_key set SOME_TOKEN value`. |