Hyprland-dotfiles/README.md
Stephan Raabe 3fd4cb10da Update
2023-11-26 11:28:25 +01:00

163 lines
6.3 KiB
Markdown

# ML4W dotfiles 2.6
This is my configuration of Hyprland (Wayland) and Qtile (Xorg & Wayland).
This package includes an installation script to install and setup the required components.
PLEASE NOTE: This branch is the rolling release of my dotfiles and includes the latest changes. Please be aware that this version is not a fully tested release.
The released dotfiles are tested with Arch Linux, Manjaro Linux, EndeavourOS and Arco Linux.
You can find the video on YouTube: <a href="https://youtu.be/5i_LMMXUDJI" target="_blank">Dotfiles Configuration and Installation</a>
## Installation
To make it easy for you to get started with my dotfiles, here's a list of recommended next steps.
PLEASE BACKUP YOUR EXISTING .config FOLDER WITH YOUR DOTFILES BEFORE STARTING THE SCRIPTS FOR INITIONAL INSTALLTION.
The script will try to create a backup from an previous dotfiles installation.
PLEASE READ THIS README until the end before starting the installation.
### Installation with GIT (Rolling Release of main branch)
```
# 1.) Change into your Downloads folder
cd ~/Downloads
# 2.) Clone the dotfiles repository into the Downloads folder
git clone https://gitlab.com/stephan-raabe/dotfiles.git
# 3.) Change into the dotfiles folder
cd dotfiles
# 4.) Start the installation
./install.sh
```
### Update with GIT (Rolling Release of main branch)
```
# 1.) Change into your Downloads folder
cd ~/Downloads
# 2.) Delete existing dotfiles folder from Downloads folder
rm -rf ~/Downloads/dotfiles
# 3.) Clone the dotfiles repository into the Downloads folder
git clone https://gitlab.com/stephan-raabe/dotfiles.git
# 4.) Change into the dotfiles folder
cd dotfiles
# 5.) Start the installation to update
./install.sh
```
To access the latest release please choose the latest tag https://gitlab.com/stephan-raabe/dotfiles/-/tags or the latest release https://gitlab.com/stephan-raabe/dotfiles/-/releases
### Installation with the dotfiles installer (Latest Release)
You can also use the dotfiles installer script to download and install the latest release: https://gitlab.com/stephan-raabe/installer
### NVIDIA
There is no official Hyprland support for Nvidia hardware. However, you might make it work properly following this page.
https://wiki.hyprland.org/Nvidia/
That's why NVIDIA GPUs are currently not supported by my dotfiles. But in upcoming releases, I will try to setup Hyprland for NVIDIA based on the article above.
## Some important key bindings
- SUPER + RETURN: Alacritty
- SUPER + CMD + RETURN: rofi application launcher
- SUPER + SHIFT + W: Change wallpaper
- SUPER + PRINT: Screenshot
- SUPER + CMS + Q: Logout screen
All keybindings for Hyprland with right mouse click on Apps in waybar or here:
https://gitlab.com/stephan-raabe/dotfiles/-/blob/main/hypr/conf/keybindings.conf?ref_type=heads
All keybindings for Qtile: https://gitlab.com/stephan-raabe/dotfiles/-/blob/main/qtile/config.py?ref_type=heads
## Templating & Settings
Hyprland & Qtile: Included is a pywal configuration that changes the color scheme based on a randomly selected wallpaper. With the key binding SuperKey + Shift + W you can change the wallpaper. SuperKey + Ctrl + W opens rofi with a list of installed wallpapers for your individual selection. See also the .bashrc and the key bindings on Hyprland and Qtile for more alias definitions.
Hyprland: In addition, you can switch the Waybar Template with SUPER + CTRL + T or by pressing the "..." icon in Waybar. The templates are available in ~/dotfiles/waybar/themes. You can add your own personal themes into this folder. The script will read in the folder structure. You can open the settings script with SUPER + CMD + S to select variations for your hyprland.conf and customize your desktop even more.
Qtile X11: In addition, you can switch between the Qtile status bar and Polybar with SUPER + SHIFT + S
## Screenshots Hyprland
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v26/screenshot-26-1.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v26/screenshot-26-2.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank">Watch on YouTube</a>
## Screenshots Qtile X11
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v25/screenshot-25-3.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v25/screenshot-25-4.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank">Watch on YouTube</a>
## Screenshots Qtile Wayland
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v25/screenshot-25-1.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank"><img src="screenshots/v25/screenshot-25-2.png" alt="Click to watch on YouTube" /></a>
<a href="https://youtu.be/5i_LMMXUDJI" target="_blank">Watch on YouTube</a>
<b><a href="https://gitlab.com/stephan-raabe/dotfiles/-/tree/main/screenshots?ref_type=heads">You can find more screenshots here.</a></b>
## Please note
In case you have issues with starting Waybar please make sure that only one xdg-desktop-portal-x is installed additionally to xdg-desktop-portal.
I had several issues with xdg-desktop-portal-wlr on Hyprland and Waybar. Please make sure that xdg-desktop-portal-wlr is uninstalled and xdg-desktop-portal-hyprland is installed.
More information you can find here:
https://gist.github.com/PowerBall253/2dea6ddf6974ba4e5d26c3139ffb7580
Please note that every Arch Linux system is different and I cannot guarantee that everything works fine on your system.
## General Packages
- Terminal: alacritty
- Editor: nvim
- Prompt: starship
- Icons: Font Awesome
- Launch Menus: Rofi
- Colorscheme: pywal
- Browsers: chromium (brave optional)
- Filemanager: Thunar
- Cursor: Bibata Modern Ice
- Icons: Papirus-Icon-Theme
## Hyprland
- Status Bar: waybar
- Screenshots: grim & slurp
- Clipboard Manager: cliphist
- Logout: wlogout
- Screenlock: swaylock-effects
## Qtile Wayland
- Status Bar: Qtile status bar
- Screenshots: grim & slurp
- Clipboard Manager: cliphist
- Logout: rofi power menu
- Screenlock: swaylock-effects
## Qtile X11
- Compositor: picom
- Status Bar: Qtile status bar + Polybar (optional)
- Screenshots: scrot