discover · compare · collections · requirements · contribute · feed · watching · stats · help with your tokens
HyDE-Project/HyDE · source
Snapshot 0 · 2026-11-04T12:47:27Z · Shell · GPL-3.0
Content fingerprint
2f512144e0f24b40b367558f12f22585ed82259f8f3b08828f54af4ec4046abeGitHub description at capture
HyDE, your Development Environment 🖥️💻
README at capture
<div align = center>
<a href="https://discord.gg/AYbJ9MJez7">
<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">
</a>
</div>
###### _<div align="right"><a id=-design-by-t2></a><sub>// design by t2</sub></div>_
<!--
Multi-language README support
-->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[](Source/docs/README.es.md)
[](Source/docs/README.de.md)
[](Source/docs/README.nl.md)
[](Source/docs/README.zh.md)
[](Source/docs/README.fr.md)
[](Source/docs/README.ar.md)
[](Source/docs/README.pt-br.md)
[](Source/docs/README.tr.md)
<div align="center">
<br>
<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](./Hyprdots-to-HyDE.md)
<!--
<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](https://wiki.archlinux.org/title/Arch_Linux) install, but **may** work on some [Arch-based distros](https://wiki.archlinux.org/title/Arch-based_distributions).
While installing HyDE alongside another [DE](https://wiki.archlinux.org/title/Desktop_environment)/[WM](https://wiki.archlinux.org/title/Window_manager) should work, due to it being a heavily customized setup, it **will** conflict with your [GTK](https://wiki.archlinux.org/title/GTK)/[Qt](https://wiki.archlinux.org/title/Qt) theming, [Shell](https://wiki.archlinux.org/title/Command-line_shell), [SDDM](https://wiki.archlinux.org/title/SDDM), [GRUB](https://wiki.archlinux.org/title/GRUB), etc. and is at your own risk.
For NixOS support there is a separate project being maintained @ [Hydenix](https://github.com/richen604/hydenix/tree/main)
> [!IMPORTANT]
> The install script will auto-detect an NVIDIA card and install a matching DKMS driver path for your kernel.
> Newer cards may use `nvidia-dkms` / `nvidia-open-dkms`, while legacy cards should be checked first against [`Scripts/nvidia-db/`](./Scripts/nvidia-db/).
> Please ensure that your NVIDIA card supports the DKMS driver family selected for it in the list provided [here](https://wiki.archlinux.org/title/NVIDIA).
>
> If a DKMS package is selected, expect a local module build for the current kernel during installation. This can take several minutes and may happen even when an NVIDIA DKMS package was already installed, because DKMS rebuilds modules for the active kernel.
> [!CAUTION]
> The script modifies your `grub` or `systemd-boot` config to enable NVIDIA DRM.
> [!TIP]
> BigLinux / Manjaro users may want to take a snapshot with Timeshift before running the installer, especially when HyDE is being installed alongside an existing desktop environment. On older NVIDIA cards, review the legacy driver list in [`Scripts/nvidia-db/`](./Scripts/nvidia-db/) before continuing.
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](https://github.com/kRHYME7/Hyde-cli?tab=readme-ov-file#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](https://hydeproject.pages.dev/en/getting-started/installation).
Quick checklist for Arch-based distros such as BigLinux / Manjaro:
- Create a restore point (for example with Timeshift) before running `install.sh`.
- Expect changes to GRUB, SDDM, and `/etc/pacman.conf` during installation.
- If your GPU is an older NVIDIA model, verify whether it belongs to a legacy dkms series before accepting the default driver path.
- If a `*-dkms` NVIDIA package is selected, expect a local module build for the current kernel during install; this can take a while even if the package was already installed previously.
- Reboot after the installer finishes, then select the Hyprland / HyDE session from the display manager.
<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](CONTRIBUTING.md) for guidelines
- Read about team roles in [TEAM_ROLES.md](TEAM_ROLES.md)
- Review our release process in [RELEASE_POLICY.md](RELEASE_POLICY.md)
- Add yourself to [CONTRIBUTORS.md](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"/>
---
> [!NOTE]
> If you are upgrading from an older version to the new Lua configuration, please follow the [Lua Migration Guide](https://hydeproject.pages.dev/en/help/lua/) in the HyDE wiki.
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.
```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`.
<!--
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>
<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
```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](Scripts/hydevm/README.md).
<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](https://github.com/HyDE-Project/hyde-themes).
<div align="center">
<table><tr><td>
[](https://github.com/HyDE-Project/hyde-themes/tree/Catppuccin-Latte)
[](https://github.com/HyDE-Project/hyde-themes/tree/Catppuccin-Mocha)
[](https://github.com/HyDE-Project/hyde-themes/tree/Decay-Green)
[](https://github.com/HyDE-Project/hyde-themes/tree/Edge-Runner)
[](https://github.com/HyDE-Project/hyde-themes/tree/Frosted-Glass)
[](https://github.com/HyDE-Project/hyde-themes/tree/Graphite-Mono)
[](https://github.com/HyDE-Project/hyde-themes/tree/Gruvbox-Retro)
[](https://github.com/HyDE-Project/hyde-themes/tree/Material-Sakura)
[](https://github.com/HyDE-Project/hyde-themes/tree/Nordic-Blue)
[](https://github.com/HyDE-Project/hyde-themes/tree/Rose-Pine)
[](https://github.com/HyDE-Project/hyde-themes/tree/Synth-Wave)
[](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](https://github.com/prasanthrangan/hyprdots/wiki/Theming).
> If you wish to have your hyde theme showcased, or you want to find some non-official themes, visit [kRHYME7/hyde-gallery](https://github.com/kRHYME7/hyde-gallery)!
<div align="right">
<br>
<a href="#-design-by-t2"><kbd> <br> 🡅 <br> </kbd></a>
</div>
<a id="styles"></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=STYLES" width="450"/>
---
<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"/>
[](https://starchart.cc/HyDE-Project/HyDE)
---
<a id="credits"></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=THANK YOU!" width="450"/>
- [See the full Credits page here](./CREDITS.md).
---
<div align="right">
<br>
<a href="#-design-by-t2"><kbd> <br> 🡅 <br> </kbd></a>
</div>
<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](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<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>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!