Check this out for the full note:
[Journey to HyDE and beyond](./Hyprdots-to-HyDE.md)
---
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 nvidia-dkms drivers for your kernel.
> Please ensure that your NVIDIA card supports dkms drivers in the list provided [here](https://wiki.archlinux.org/title/NVIDIA).
> [!CAUTION]
> The script modifies your `grub` or `systemd-boot` config to enable NVIDIA DRM.
To install, execute the following commands:
```shell
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.
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://github.com/HyDE-Project/HyDE/wiki/installation).
---
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!
---
To update HyDE, you will need to pull the latest changes from GitHub and restore the configs by running the following commands:
```shell
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`.
---
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).
> [!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)!
