Skip to content

installation

Jump to bottom
kRHYME7 edited this page Dec 12, 2024 · 1 revision

title: Installation description: HyDE Installation guide

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.

Option 1

Automated installation script

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/custom_apps.lst and pass the file as a parameter to install it like so:

./install.sh custom_apps.lst

Granular and Manual Installation

Clone

Clone the repo and change the directory to the script path. Then make sure the user has [w]rite and e[x]ecute permission to the clone directory

pacman -Sy git
git clone --depth 1 https://github.com/prasanthrangan/hyprdots ~/HyDE
cd ~/HyDE/Scripts

Caution

NEVER ever execute the script with sudo or as root user!

Modes

The install script can be executed in different modes,

  • for default full hyprland installation with all configs
./install.sh
  • for full or minimal hyprland installation + your favorite packages (ex. custom_apps.lst)
./install.sh custom_apps.lst # full install custom_hypr.lst + custom_app.lst with configs
./install.sh -i custom_apps.lst # minimal install custom_hypr.lst + custom_app.lst without configs
  • each section can also be independently executed as,
./install.sh -i # minimal install hyprland without any configs
./install.sh -d # minimal install hyprland without any configs, but with (--noconfirm) install
./install.sh -r # just restores the config files
./install.sh -s # start and enable system services
./install.sh -t # test run without executing (-irst to dry run all)
./install.sh -m # skips the theme installation
./install.sh -n # skips nvidia installation
./install.sh -irst # to do a test run for all
./install.sh -irst # to do a test run for all

Option 2

Important

HyDE-CLI author here. The CLI's dots management (Hyde {restore,backup,control,override}) is not yet and might not be 100% compatible of the current hyprdots. This is due to incompatibility of the meta files and the above commands need manual intervention Rest assured that other commands are working perfectly and will be ported to its own hydectl command line interface

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.

Option 3

...Soon A declarative way to manage importing and exporting dotfiles from other users. This is not for boot strapping but for sharing dotfiles.

Important

Please reboot after the install script completes and takes you to the SDDM login screen (or black screen) for the first time.

Clone this wiki locally