From b47b78616e04b61aa6ed70b3e18ae5ab63270088 Mon Sep 17 00:00:00 2001 From: SeraphimeZelel Date: Sun, 7 Sep 2025 03:52:04 +0700 Subject: [PATCH] (docs) : finalize the documentation (this time for real) --- README.md | 343 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 215 insertions(+), 128 deletions(-) diff --git a/README.md b/README.md index c5a5ed8..c8d5c3b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ # Showcase + [![Watch the video](https://img.youtube.com/vi/tJPglNR69ok/hqdefault.jpg)](https://youtu.be/tJPglNR69ok) This contains My Fedora Linux dotfiles for a Hyprland-looks in **GNOME** setup. @@ -13,10 +14,9 @@ This contains My Fedora Linux dotfiles for a Hyprland-looks in **GNOME** setup. -Rion Zaphkiel -> [!WARNING] -> -> All Configurations were meant to be used with `Pywal` +> [!WARNING] > +> All Configurations were meant to be used with `Pywal` --- @@ -26,9 +26,11 @@ This contains My Fedora Linux dotfiles for a Hyprland-looks in **GNOME** setup. 🪟 Forge ### Description + Tiling and window manager for GNOME. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -36,23 +38,32 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- forge1 - forge2 -

+ + + + + +
+ forge1 + + forge2 +
--- +
🌫️ Blur My Shell ### Description + Adds a blur look to different parts of the GNOME Shell, including the top panel, dash and overview. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -60,27 +71,33 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- blur1 - blur2 - blur3 - blur4 - blur5 -

+ + + + + + + + + + +
blur1blur2blur3
blur4blur5
--- -
+
🎛️ Just Perfection ### Description + Tweak Tool to Customize GNOME Shell, Change the Behavior and Disable UI Elements. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -88,28 +105,33 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- jp1 - jp2 - jp3 - jp4 - jp5 -

+ + + + + + + + + + +
jp1jp2jp3
jp4jp5
- --- -
+
🎵 Media Controls ### Description + Show controls and information of the currently playing media in the panel. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -117,28 +139,33 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- mc1 - mc2 - mc3 - mc4 - mc5 -

+ + + + + + + + + + +
mc1mc2mc3
mc4mc5
--- +
- -
🍹 Open Bar ### Description + Top Bar / Top Panel , Menus , Dash / Dock , Gnome Shell , Gtk Apps theming. Open the bar and let the colors flow. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -146,25 +173,29 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- bar1 - bar2 - bar3 -

+ + + + + + +
bar1bar2bar3
--- -
+
⚡ Quick Settings Tweaks ### Description + Enhances the quick settings menu with extra toggles and controls. ### Settings + You can follow my settings to get the same style in screenshot below, or you can tweak it as you will.
@@ -172,16 +203,21 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- qs1 - qs2 - qs3 - qs4 -

+ + + + + + + + + +
qs1qs2
qs3qs4
--- +
@@ -198,36 +234,43 @@ You can follow my settings to get the same style in screenshot below, or you can - Unblank lock screen : Unblank lock screen. Helping for ricing showcase
- ## Applications +
🎨 BetterDiscord
-

- better-discord1 - better-discord2 -

+ + + + + +
better-discord1better-discord2
### Overview + - ✔️ BetterDiscord is a client mod with endless flexibility and addons. The only limit to the customization is your own imagination. - 🧩 Extending the platform is as easy as clicking install on a plugin or theme. - 🎨 BetterDiscord will help you have a beautiful and more useful user experience on Discord. ### Installation + 1. Install [BetterDiscord](https://docs.betterdiscord.app/users/getting-started/installation#manual-installation). 2. Restart Discord. ### Configuration + 1. On Settings > BetterDiscord > Enable Custom CSS and Enable Transparency. 2. Paste the `.config/BetterDiscord` into `~/.config/BetterDiscord` 3. `discord-pywalsync.sh` is used to overwrite the css color with pywal generated color palette. The script calls as a hook when running `wallpaper-picker.sh` so it automatically matches the color whenever you change your wallpaper. ### Notes + ⚠️ BetterDiscord is third-party and not officially supported by Discord. Use at your own risk. --- +
@@ -235,21 +278,27 @@ You can follow my settings to get the same style in screenshot below, or you can
-

- btop1 - btop2 -

+ + + + + +
btop1btop2
### Overview + Resource monitor that shows usage and stats for processor, memory, disks, network and processes. ### Installation + 1. Install [btop](https://github.com/aristocratos/btop?tab=readme-ov-file#installation) ### Configuration + 1. Paste the `.config/btop` into `~/.config/btop` --- +
@@ -257,22 +306,28 @@ Resource monitor that shows usage and stats for processor, memory, disks, networ
-

- cava1 - cava2 -

+ + + + + +
cava1cava2
+ +### Overview -### Overview Cross-platform Audio Visualizer. Cava is a bar spectrum audio visualizer for terminal or desktop (SDL). ### Installation + 1. Install [cava](https://github.com/karlstav/cava?tab=readme-ov-file#installing) ### Configuration + 1. Paste the `.config/cava` into `~/.config/cava` 2. `cava-pywalsync.sh` is used to match the cava color with pywal generated color palette. The script calls as a hook when running `wallpaper-picker.sh` so it automatically matches the color whenever you change your wallpaper. --- +
@@ -280,24 +335,30 @@ Cross-platform Audio Visualizer. Cava is a bar spectrum audio visualizer for ter
-

- ff1 - ff2 - ff3 -

- + + + + + + +
ff1ff2ff3
+ ### Overview + Fastfetch is a neofetch-like tool for fetching system information and displaying it in a visually appealing way. It is written mainly in C, with a focus on performance and customizability. Currently, it supports Linux, macOS, Windows 7+, Android, FreeBSD, OpenBSD, NetBSD, DragonFly, Haiku, and SunOS. ### Installation + 1. Install [fastfetch](https://github.com/fastfetch-cli/fastfetch?tab=readme-ov-file#installation) ### Configuration + 1. Paste the `.config/fastfetch` into `~/.config/fastfetch` 2. `wallpaper-picker.sh` changes the logo and the wife name, based on the wallpaper name. i.e. if the file name is `Arknight_Theresa`, then the logo will set into `john_arknight` and the wife name into `Theresa`. 3. `fastfetch_auto.sh` is a script that detects the change of fastfetch config and reloads it, so you don’t have to call fastfetch multiple times. --- +
@@ -307,14 +368,17 @@ Fastfetch is a neofetch-like tool for fetching system information and displaying Pywal is a tool that generates a color palette from the dominant colors in an image. It then applies the colors system-wide and on-the-fly in all of your favourite programs. ### Installation + 1. Install [pywal](https://github.com/dylanaraps/pywal/wiki/Installation) ### Configuration + 1. Paste the `.config/wal` into `~/.config/wal` 2. `wallpaper-picker.sh` calls pywal to generate color palette based on the wallpaper name (if the theme exists) or the dominant color of your wallpaper. i.e. I have `.config/wal/themes/Arknights.json` so if I set my wallpaper to `Arknights_Amiya` it applies the predefined theme rather than the dominant color of the wallpaper. It also calls `.config/wal/hooks/hooks.sh`. 3. `hooks.sh` syncs the theme across all of the applications that are being used. --- +
@@ -324,12 +388,15 @@ Pywal is a tool that generates a color palette from the dominant colors in an im WezTerm is a powerful cross-platform terminal emulator and multiplexer written by @wez and implemented in Rust. ### Installation + 1. Install [wezterm](https://wezterm.org/installation) ### Configuration + 1. Paste the `.config/wezterm` into `~/.config/wezterm` --- +
@@ -337,67 +404,73 @@ WezTerm is a powerful cross-platform terminal emulator and multiplexer written b
-

- wlogout1 - wlogout2 -

+ + + + + +
wlogout1wlogout2
### Overview + A Wayland-based logout menu. ### Installation + 1. Install [wlogout](https://github.com/ArtsyMacaw/wlogout) ### Configuration + 1. Paste the `.config/wlogout` into `~/.config/wlogout` 2. `wlogout-pywalsync.sh` is used to get your set wallpaper, and makes it blur to use as a background in wlogout. --- +
🔍 Wofi -
- -

- wofi1 - wofi2 -

- -
- -

- wofiwp1 - wofiwp2 -

+ + + + + + + + + +
wofi1wofi2
wofiwp1wofiwp2
### Overview + Wofi is a launcher/menu program for wlroots-based Wayland compositors such as sway. ### Installation + 1. Install [wofi](https://github.com/SimplyCEO/wofi?tab=readme-ov-file#building) ### Configuration + 1. Paste the `.config/wofi` into `~/.config/wofi` -2. `wallpaper-picker.sh` calls wofi to show the thumbnail of available wallpapers — don’t forget to set the right path to your wallpaper directory. +2. `wallpaper-picker.sh` calls wofi to show the thumbnail of available wallpapers — don’t forget to set the right path to your wallpaper directory. --- +
✨ Other cool applications -- 🎵 **kew**: Listen to music in the terminal. +- 🎵 **kew**: Listen to music in the terminal. - 💻 **CMatrix**: A terminal screensaver that simulates the “Matrix rain” effect, just like in the movie.
- ## Script -> [!WARNING] -> +> [!WARNING] +> > To fully utilize the scripts, you need to install a few dependencies: > > ``` @@ -406,33 +479,38 @@ Wofi is a launcher/menu program for wlroots-based Wayland compositors such as sw > wofi > pywal > ``` -> + ---
🖼 wallpaper-picker.sh ### What it does -- Provides a wallpaper picker using **Wofi** with image thumbnails. -- Automatically applies Pywal colors, updates GNOME wallpaper, changes Fastfetch logo, and runs hooks. -- Integrates with **Pywalfox** to update Firefox theme. + +- Provides a wallpaper picker using **Wofi** with image thumbnails. +- Automatically applies Pywal colors, updates GNOME wallpaper, changes Fastfetch logo, and runs hooks. +- Integrates with **Pywalfox** to update Firefox theme. ### Notes on Color Backends -Pywal supports different color extraction backends that slightly change the generated palette. -You can switch backends by adding the `--backend` argument after `"$WAL_BIN" -i "$SELECTED"` in `wallpaper-picker.sh`. -- **wal (default)** → balanced palette, optimized for terminals. -- **colorz** → stronger contrast, fewer dominant colors. (Looks great on Chiori wallpapers). -- **haishoku** → softer palettes with lower contrast. +Pywal supports different color extraction backends that slightly change the generated palette. +You can switch backends by adding the `--backend` argument after `"$WAL_BIN" -i "$SELECTED"` in `wallpaper-picker.sh`. + +- **wal (default)** → balanced palette, optimized for terminals. +- **colorz** → stronger contrast, fewer dominant colors. (Looks great on Chiori wallpapers). +- **haishoku** → softer palettes with lower contrast. This setup is optimized for the default **wal** backend. However, you can further customize the derived color variables if you’re not satisfied with the results: -- 🎶 For **Cava**, change the gradient source in `cava-pywalsync.sh`, e.g. +- 🎶 For **Cava**, change the gradient source in `cava-pywalsync.sh`, e.g. + ```bash COLOR1=$(jq -r '.colors.color8' "$WAL_COLORS") ``` + to + ```bash COLOR1=$(jq -r '.colors.color5' "$WAL_COLORS") ``` @@ -486,60 +564,66 @@ pip install haishoku - --- +
🎶 cava-pywalsync.sh ### What it does -- Syncs **Cava’s** gradient colors with Pywal’s generated color scheme. -- Automatically restarts Cava to apply the new colors. + +- Syncs **Cava’s** gradient colors with Pywal’s generated color scheme. +- Automatically restarts Cava to apply the new colors. --- +
💬 discord-pywalsync.sh ### What it does -- Updates **BetterDiscord’s** `custom.css` file using Pywal colors. -- Combines your header, Pywal CSS, and template into one file. -- Ensures Discord follows the same color scheme as the rest of your rice. + +- Updates **BetterDiscord’s** `custom.css` file using Pywal colors. +- Combines your header, Pywal CSS, and template into one file. +- Ensures Discord follows the same color scheme as the rest of your rice. --- +
🖼 scaler-wallpaper.sh ### What it does -- Ensures all wallpapers are scaled to **1920x1080** resolution. -- Converts them to `.png` format if necessary. -- Moves the original wallpaper to `~/Pictures/.backup` with incremental names for safe keeping. + +- Ensures all wallpapers are scaled to **1920x1080** resolution. +- Converts them to `.png` format if necessary. +- Moves the original wallpaper to `~/Pictures/.backup` with incremental names for safe keeping. --- +
🚪 wlogout-pywalsync.sh ### What it does -- Generates a blurred and darkened version of your current wallpaper for **Wlogout** background. -- Updates `style.css` for Wlogout with Pywal colors. -- Keeps logout menu consistent with your rice. + +- Generates a blurred and darkened version of your current wallpaper for **Wlogout** background. +- Updates `style.css` for Wlogout with Pywal colors. +- Keeps logout menu consistent with your rice. --- -
+ ## 🛠 Help & Setup Guide > [!WARNING] > The instructions below will **overwrite your existing config files**. -> Don’t worry — your old configs will be safely moved into a backup folder with a timestamp. - +> Don’t worry — your old configs will be safely moved into a backup folder with a timestamp. Quick setup instructions: @@ -548,6 +632,7 @@ Quick setup instructions: git clone https://github.com/SeraphimeZelel/rion-ricing.git ~/.rion-dotfiles ``` 2. **Symlink the config files** + ```bash #!/bin/bash @@ -573,6 +658,7 @@ Quick setup instructions: echo "✅ All configs linked. Backup saved in $BACKUP" ``` + 3. **Symlink the scripts** ```bash ln -s ~/.rion-dotfiles/.script/* ~/.local/bin @@ -583,26 +669,27 @@ Quick setup instructions: ``` ## 📝 Notes + If `wallpaper-picker.sh` fails to set your wallpaper, try renaming the file with the prefix `Anything_`. - Example: - ``` - Endfield_NotReal.png - Endfield_Tomorrow.png - ``` +Example: -### ⌨️ Keyboard Shortcut +``` +Endfield_NotReal.png +Endfield_Tomorrow.png +``` -| Name | Command | Shortcut | -|------------------|-----------|-----------| -| File Manager | `nautilus` | `Super + E` | +### ⌨️ Keyboard Shortcut + +| Name | Command | Shortcut | +| ---------------- | ----------------------------------------------- | ----------- | +| File Manager | `nautilus` | `Super + E` | | Wallpaper Picker | `/home/yourname/.local/bin/wallpaper-picker.sh` | `Alt + W` | -| WezTerm | `wezterm` | `Super + T` | -| wlogout | `wlogout` | `Alt + L` | -| wofi | `wofi` | `Alt + F` | +| WezTerm | `wezterm` | `Super + T` | +| wlogout | `wlogout` | `Alt + L` | +| wofi | `wofi` | `Alt + F` | --- -
[![Typing SVG](https://readme-typing-svg.demolab.com?font=JetBrains+Mono&size=30&duration=2000&pause=2500&color=DFCB00¢er=true&vCenter=true&width=435&lines=Endfield+Copium+Corner)](https://git.io/typing-svg) @@ -612,13 +699,13 @@ If `wallpaper-picker.sh` fails to set your wallpaper, try renaming the file with
- Endfield not Real + Endfield not Real - Copium + Copium - endfieldtomorrow
+ endfieldtomorrow