HyDE

HyDE copied to clipboard

_{// design by t2}

Check this out for the full note: Journey to HyDE and beyond

https://github.com/prasanthrangan/hyprdots/assets/106020512/7f8fadc8-e293-4482-a851-e9c6464f5265

The installation script is designed for a minimal Arch Linux install, but may work on some Arch-based distros. While installing HyDE alongside another DE/WM should work, due to it being a heavily customized setup, it will conflict with your GTK/Qt theming, Shell, SDDM, GRUB, etc. and is at your own risk.

For NixOS support there is a separate project being maintained @ Hydenix

[!IMPORTANT] The install script will auto-detect an NVIDIA card and install nvidia-dkms drivers for your kernel. Please ensure that your NVIDIA card supports dkms drivers in the list provided here.

[!CAUTION] The script modifies your grub or systemd-boot config to enable NVIDIA DRM.

To install, execute the following commands:

sudo pacman -S --needed git base-devel
git clone --depth 1 https://github.com/HyDE-Project/HyDE ~/HyDE
cd ~/HyDE/Scripts
./install.sh

[!TIP] You can also add any other apps you wish to install alongside HyDE to Scripts/pkg_user.lst and pass the file as a parameter to install it like so:

./install.sh pkg_user.lst

[!IMPORTANT] Refer your list from Scripts/pkg_extra.lst or you can cp Scripts/pkg_extra.lst Scripts/pkg_user.lst if you wish to install all extra packages.

Please reboot after the install script completes and takes you to the SDDM login screen (or black screen) for the first time. For more details, please refer to the installation wiki.

We welcome contributions from the community! To get started:

• Check our CONTRIBUTING.md for guidelines
• Read about team roles in TEAM_ROLES.md
• Review our release process in RELEASE_POLICY.md
• Add yourself to CONTRIBUTORS.md when making your first PR

Whether you're helping with code, testing, or documentation, we appreciate your support in making HyDE better for everyone. Thank you!

To update HyDE, you will need to pull the latest changes from GitHub and restore the configs by running the following commands:

cd ~/HyDE/Scripts
git pull origin master
./install.sh -r

[!IMPORTANT] Please note that any configurations you made will be overwritten if listed to be done so as listed by Scripts/restore_cfg.psv. However, all replaced configs are backed up and may be recovered from in ~/.config/cfg_backups.

HyDEVM is a script that allows you to run HyDE in a virtual machine for testing and development.

Quick Start

Arch Linux

# Download and run (will auto-detect missing packages)
curl -L https://raw.githubusercontent.com/HyDE-Project/HyDE/main/Scripts/hydevm/hydevm.sh -o hydevm
chmod +x hydevm
./hydevm

NixOS (or Nix)

# Using flakes from HyDE repository
nix run github:HyDE-Project/HyDE

# Or if you have the repository cloned locally
nix run .

For more details, please refer to the HyDEVM README.

All our official themes are stored in a separate repository, allowing users to install them using themepatcher. For more information, visit HyDE-Project/hyde-themes.

[!TIP] Everyone, including you can create, maintain, and share additional themes, all of which can be installed using themepatcher! To create your own custom theme, please refer to the theming wiki. If you wish to have your hyde theme showcased, or you want to find some non-official themes, visit kRHYME7/hyde-gallery!

Theme Select

Wallpaper Select	Launcher Select
Wallbash Modes	Notification Action

Rofi Launcher

Wlogout Menu

Game Launcher

• See the full Credits page here.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Rubin Bhandari 💻

Khing 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!