Repository: HyDE-Project/HyDE

Stars: 8768

README.md

###### _<div align="right"><a id=-design-by-t2></a><sub>// design by t2</sub></div>_

!hyde_banner

![All Contributors](#contributors-)

![es](Source/docs/README.es.md)
![de](Source/docs/README.de.md)
![nl](Source/docs/README.nl.md)
![中文](Source/docs/README.zh.md)
![fr](Source/docs/README.fr.md)
![ar](Source/docs/README.ar.md)
![pt-br](Source/docs/README.pt-br.md)
![tr](Source/docs/README.tr.md)

<br>

<a href="#installation"><kbd> <br> Installation <br> </kbd></a>&ensp;&ensp;
<a href="#updating"><kbd> <br> Updating <br> </kbd></a>&ensp;&ensp;
<a href="#themes"><kbd> <br> Themes <br> </kbd></a>&ensp;&ensp;
<a href="#styles"><kbd> <br> Styles <br> </kbd></a>&ensp;&ensp;
<a href="CONTRIBUTING.md"><kbd> <br> Contributing <br> </kbd></a>&ensp;&ensp;
<a href="KEYBINDINGS.md"><kbd> <br> Keybindings <br> </kbd></a>&ensp;&ensp;
<a href="https://www.youtube.com/watch?v=2rWqdKU1vu8&list=PLt8rU_ebLsc5yEHUVsAQTqokIBMtx3RFY&index=1"><kbd> <br> Youtube <br> </kbd></a>&ensp;&ensp;
<a href="https://hydeproject.pages.dev/"><kbd> <br> Wiki <br> </kbd></a>&ensp;&ensp;
<a href="https://discord.gg/qWehcFJxPa"><kbd> <br> Discord <br> </kbd></a>

</div><br><br>

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">

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

<br>

---

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 grub or systemd-boot config to enable NVIDIA DRM.

To install, execute the following commands:

shell

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:

> ``shell


./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.

<!--

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. -->

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>

<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:

WARNINGThe following commands will discard any uncommitted local changes in the repository.

shell

cd ~/HyDE/Scripts
git fetch --update-shallow --depth 1 origin master
git reset --hard 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

bash

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)

bash

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.

![Catppuccin-Latte](https://github.com/HyDE-Project/hyde-themes/tree/Catppuccin-Latte)
![Catppuccin-Mocha](https://github.com/HyDE-Project/hyde-themes/tree/Catppuccin-Mocha)
![Decay-Green](https://github.com/HyDE-Project/hyde-themes/tree/Decay-Green)
![Edge-Runner](https://github.com/HyDE-Project/hyde-themes/tree/Edge-Runner)
![Frosted-Glass](https://github.com/HyDE-Project/hyde-themes/tree/Frosted-Glass)
![Graphite-Mono](https://github.com/HyDE-Project/hyde-themes/tree/Graphite-Mono)
![Gruvbox-Retro](https://github.com/HyDE-Project/hyde-themes/tree/Gruvbox-Retro)
![Material-Sakura](https://github.com/HyDE-Project/hyde-themes/tree/Material-Sakura)
![Nordic-Blue](https://github.com/HyDE-Project/hyde-themes/tree/Nordic-Blue)
![Rosé-Pine](https://github.com/HyDE-Project/hyde-themes/tree/Rose-Pine)
![Synth-Wave](https://github.com/HyDE-Project/hyde-themes/tree/Synth-Wave)
![Tokyo-Night](https://github.com/HyDE-Project/hyde-themes/tree/Tokyo-Night)

</td></tr></table>
</div>

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!

---

<div align="center"><table><tr>Theme Select</tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/theme_select_1.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/theme_select_2.png"/></td></tr></table></div>

<div align="center"><table><tr><td>Wallpaper Select</td><td>Launcher Select</td></tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/walls_select.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_sel.png"/></td></tr>
<tr><td>Wallbash Modes</td><td>Notification Action</td></tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/wb_mode_sel.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/notif_action_sel.png"/></td></tr>
</table></div>

<div align="center"><table><tr>Rofi Launcher</tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_1.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_2.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_3.png"/></td></tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_4.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_5.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_6.png"/></td></tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_7.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_8.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_9.png"/></td></tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_10.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_11.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/rofi_style_12.png"/></td></tr>
</table></div>

<div align="center"><table><tr>Wlogout Menu</tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/wlog_style_1.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/wlog_style_2.png"/></td></tr></table></div>

<div align="center"><table><tr>Game Launcher</tr><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/game_launch_1.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/game_launch_2.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/game_launch_3.png"/></td></tr></table></div>
<div align="center"><table><tr><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/game_launch_4.png"/></td><td>
<img src="https://raw.githubusercontent.com/prasanthrangan/hyprdots/main/Source/assets/game_launch_5.png"/></td></tr></table></div>

<a id="star_history"></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=STARS" width="450"/>

![Stargazers over time](https://starchart.cc/HyDE-Project/HyDE)

---

- See the full Credits page here.

---

<div align="right">
<sub>Last edited on: 27/02/2025<span id="last-edited"></span></sub>
</div>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://rubiin.is-a.dev"><img src="https://avatars.githubusercontent.com/u/8222059?v=4?s=100" width="100px;" alt="Rubin Bhandari"/><br /><sub><b>Rubin Bhandari</b></sub></a><br /><a href="https://github.com/HyDE-Project/HyDE/commits?author=rubiin" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kRHYME7"><img src="https://avatars.githubusercontent.com/u/53417443?v=4?s=100" width="100px;" alt="Khing"/><br /><sub><b>Khing</b></sub></a><br /><a href="https://github.com/HyDE-Project/HyDE/commits?author=kRHYME7" title="Code">💻</a> <a href="https://github.com/HyDE-Project/HyDE/commits?author=kRHYME7" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>

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

Repository: HyDE-Project/HyDE

Stars: 8768

README.md Copy Chapter

Quick Start Copy Chapter

Arch Linux Copy Section

Download and run (will auto-detect missing packages)

NixOS (or Nix) Copy Section

Using flakes from HyDE repository

Or if you have the repository cloned locally

Contributors ✨ Copy Chapter

Explore Related Technologies & Topics

README.md

Quick Start

Arch Linux

NixOS (or Nix)

Contributors ✨