HyDE
HyDE, your Development Environment π₯οΈπ»
Install / Use
/learn @HyDE-Project/HyDEREADME
<div align="right"><a id=-design-by-t2></a><sub>// design by t2</sub></div>

<a href="#installation"><kbd>β<br>βInstallationβ<br>β</kbd></a>ββ <a href="#updating"><kbd>β<br> Updating <br>β</kbd></a>ββ <a href="#themes"><kbd>β<br>βThemesβ<br>β</kbd></a>ββ <a href="#styles"><kbd>β<br>βStylesβ<br>β</kbd></a>ββ <a href="CONTRIBUTING.md"><kbd>β<br>βContributingβ<br>β</kbd></a>ββ <a href="KEYBINDINGS.md"><kbd>β<br>βKeybindingsβ<br>β</kbd></a>ββ <a href="https://www.youtube.com/watch?v=2rWqdKU1vu8&list=PLt8rU_ebLsc5yEHUVsAQTqokIBMtx3RFY&index=1"><kbd>β<br>βYoutubeβ<br>β</kbd></a>ββ <a href="https://hydeproject.pages.dev/"><kbd>β<br>βWikiβ<br>β</kbd></a>ββ <a href="https://discord.gg/qWehcFJxPa"><kbd>β<br>βDiscordβ<br>β</kbd></a>
</div><br><br> <div align="center"> <div style="display: flex; flex-wrap: nowrap; justify-content: center;"> <img src="Source/assets/archlinux.png" alt="Arch Linux" style="width: 10%; margin: 10px;"/> <img src="Source/assets/cachyos.png" alt="CachyOS" style="width: 10%; margin: 10px;"/> <img src="Source/assets/endeavouros.png" alt="EndeavourOS" style="width: 10%; margin: 10px;"/> <img src="Source/assets/garuda.png" alt="Garuda" style="width: 10%; margin: 10px;"/> <img src="Source/assets/nixos.png" alt="NixOS" style="width: 10%; margin: 10px;"/> </div> </div>Check this out for the full note: Journey to HyDE and beyond
<!-- <img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscordapp.com%2Fapi%2Finvites%2FmT5YqjaJFh%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&suffix=%20members&style=for-the-badge&logo=discord&logoSize=auto&label=The%20HyDe%20Project&labelColor=ebbcba&color=c79bf0"> <img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscordapp.com%2Fapi%2Finvites%2FmT5YqjaJFh%3Fwith_counts%3Dtrue&query=%24.approximate_presence_count&suffix=%20online&style=for-the-badge&logo=discord&logoSize=auto&label=The%20HyDe%20Project&labelColor=ebbcba&color=c79bf0"> -->https://github.com/prasanthrangan/hyprdots/assets/106020512/7f8fadc8-e293-4482-a851-e9c6464f5265
<br><a id="installation"></a> <img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=25&pause=1000&color=CCA9DD&vCenter=true&width=435&height=25&lines=INSTALLATION" width="450"/>
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-open-dkms drivers for your kernel. For legacy cards check this first Please ensure that your NVIDIA card supports dkms drivers in the list provided here.
[!CAUTION] The script modifies your
gruborsystemd-bootconfig 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.lstand pass the file as a parameter to install it like so:./install.sh pkg_user.lst
<!-- As a second install option, you can also use `Hyde-install`, which might be easier for some. View installation instructions for HyDE in [Hyde-cli - Usage](https://github.com/kRHYME7/Hyde-cli?tab=readme-ov-file#usage). -->[!IMPORTANT] Refer your list from
Scripts/pkg_extra.lstor you cancp Scripts/pkg_extra.lst Scripts/pkg_user.lstif 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.
<div align="right"> <br> <a href="#-design-by-t2"><kbd>β<br>βπ‘ β<br>β</kbd></a> </div> <div align="right"> <br> <a href="#-design-by-t2"><kbd> <br> π‘ <br> </kbd></a> </div><a id="contributing"></a> <img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=25&pause=1000&color=CCA9DD&vCenter=true&width=435&height=25&lines=CONTRIBUTING" width="450"/>
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!
<div align="right"> <br> <a href="#-design-by-t2"><kbd> <br> π‘ <br> </kbd></a> </div><a id="updating"></a> <img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=25&pause=1000&color=CCA9DD&vCenter=true&width=435&height=25&lines=UPDATING" width="450"/>
To update HyDE, you will need to pull the latest changes from GitHub and restore the configs by running the following commands:
[!WARNING] The following commands will discard any uncommitted local changes in the repository.
cd ~/HyDE/Scripts
git fetch --update-shallow --depth 1 origin master
git reset --hard origin/master
./install.sh -r
<!-- As a second update option, you can use `Hyde restore ...`, which does have a better way of managing restore and backup options. For more details, you can refer to [Hyde-cli - dots management wiki](https://github.com/kRHYME7/Hyde-cli/wiki/Dots-Management). --> <div align="right"> <br> <a href="#-design-by-t2"><kbd>β<br>βπ‘ β<br>β</kbd></a> </div>[!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.
<a id="hydevm"></a> <img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=25&pause=1000&color=CCA9DD&vCenter=true&width=435&height=25&lines=HYDEVM" width="450"/>
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.
<div align="right"> <br> <a href="#-design-by-t2"><kbd>β<br>βπ‘ β<br>β</kbd></a> </div><a id="themes"></a> <img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=25&pause=1000&color=CCA9DD&vCenter=true&width=435&height=25&lines=THEMES" width="450"/>
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.
<div align="center"> <table><tr><td>