An open API service indexing awesome lists of open source software.

https://github.com/linuxbeginnings/ubuntu-hyprland

Install script for ubuntu 24.04/25.10/26.04(WIP)
https://github.com/linuxbeginnings/ubuntu-hyprland

hyprland ubuntu

Last synced: about 2 months ago
JSON representation

Install script for ubuntu 24.04/25.10/26.04(WIP)

Awesome Lists containing this project

README

          

# πŸ’Œ KooL's Ubuntu Hyprland Install Script πŸ’Œ

## For supported Ubuntu releases (choose the correct branch)



![GitHub Repo stars](https://img.shields.io/github/stars/LinuxBeginnings/Ubuntu-Hyprland?style=for-the-badge&color=cba6f7) ![GitHub last commit](https://img.shields.io/github/last-commit/LinuxBeginnings/Ubuntu-Hyprland?style=for-the-badge&color=b4befe) ![GitHub repo size](https://img.shields.io/github/repo-size/LinuxBeginnings/Ubuntu-Hyprland?style=for-the-badge&color=cba6f7)






 
 Read this First 
 
  
 
 How to Use this Script 
 
  
 
 Gallery 
 
  




πŸ‘‡ KOOL's Hyprland-Dots related Links πŸ‘‡






 
 Hyprland-Dots Ubuntu repo 
 
  
 
 Youtube 
 
  
 
 Wiki 
 
  
 
 Keybinds 
 
  
 
 FAQ 
 
  
 
 Discord 
 





Sparkles
KooL Hyprland-Dotfiles Showcase
Sparkles

https://github.com/user-attachments/assets/49bc12b2-abaf-45de-a21c-67aacd9bb872

> [!IMPORTANT]
> install a backup tool like `snapper` or `timeshift`. and Backup your system before installing hyprland using this script (HIGHLY RECOMMENDED)

> [!CAUTION]
> Download this script on a directory where you have write permissions. ie. HOME. Or any directory within your home directory. Else script will fail

#### ⚠️ Pre-requisites and VERY Important!

- Do not run this installer as `sudo` or as `root`
- This Installer requires a user with `sudo `priviledge to install packages
- Priviledge escalation is handled inside the script
- Choose the branch that matches your Ubuntu release (e.g., `24.04`, `26.04`)
> Note: With the release of ubuntu v26.04 support for v25.10 has ended
> Going forward interim releases won't be tested. (26.10,...)

### Gallery and Videos

#### πŸŽ₯ Feb 2025 Installation Video

> Note: There are many changes since then and we will be making new videos
> The basic information is still correct

- [YOUTUBE-LINK](https://youtu.be/wQ70lo7P6vA?si=_QcbrNKh_Bg0L3wC)
- [YOUTUBE-Hyprland-Playlist](https://youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx&si=iaNjLulFdsZ6AV-t)

### πŸͺ§πŸͺ§πŸͺ§ ANNOUNCEMENT πŸͺ§πŸͺ§πŸͺ§

- This Repo does not contain Hyprland Dots or configs! Dotfiles can be checked here [`Hyprland-Dots`](https://github.com/LinuxBeginnings/Hyprland-Dots/tree/Deb-Untu-Dots) . During installation, if you opt to copy pre-configured dots, it will be downloaded from that centralized repo.
- Hyprland-Dots use are constantly evolving / improving. you can check CHANGELOGS here [`Hyprland-Dots-Changelogs`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Changelogs)
- Since the Hyprland-Dots are evolving, some of the screenshots maybe old
- the wallpaper offered to be downloaded towards the end is from this [`REPO`](https://github.com/LinuxBeginnings/Wallpaper-Bank)
- The dotfiles that will be pulled by this installer is only specific. Since newer dotfiles might not work properly

### ✨ Some notes on this installer / Prerequisites

- This script targets supported Ubuntu releases; use the appropriate branch for your version.
- If you have nvidia, and wanted to use proprietary drivers, uninstall nouveau first (if installed). This script will be installing proprietary nvidia drivers and will not deal with removal of nouveau.
- NVIDIA users / owners, after installation, check [`THIS`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users)

#### ✨ Costumize the packages to be installed

- inside the `install-scripts` directory, you can edit `00-hypr-pkgs.sh`. Do not edit `00-dependencies.sh` unless you know what you are doing. Care though as the Hyprland Dots may not work properly!

### 🚩 changing login manager to SDDM

- if you really want to change login manager, there are couple of things you need to carry out before running this install script
- first install sddm. the no-install-recommends is suggested else it will pull lots of plasma depencies.

```bash
sudo apt install --no-install-recommends -y sddm
```

- then ran `sudo dpkg-reconfigure sddm` choose sddm and then reboot.
- once reboot done, you can ran the script and choose sddm & sddm theme
- [LINK](https://www.simplified.guide/ubuntu/switch-to-gdm) for some guide

#### πŸ’« SDDM and GTK Themes offered

- If you opted to install SDDM theme, here's the [`LINK`](https://github.com/LinuxBeginnings/simple-sddm-2) which is a modified fork of [`LINK`](https://github.com/Keyitdev/sddm-astronaut-theme)
- If you opted to install GTK Themes, Icons, here's the [`LINK`](https://github.com/LinuxBeginnings/GTK-themes-icons). This also includes Bibata Modern Ice cursor.

####

## ✨ Auto clone and install

> [!CAUTION]
> If you are using `FISH` SHELL, DO NOT use this function. Clone and run `install.sh` instead

- you can use this command to automatically clone the installer and run the script for you
- NOTE: `curl` package is required before running this command

```bash
sh <(curl -L https://raw.githubusercontent.com/LinuxBeginnings/Ubuntu-Hyprland//auto-install.sh)
```

## ✨ to use this script

> clone this repo (latest commit only) by using git. Change directory, make executable and run the script

```bash
git clone --depth=1 -b https://github.com/LinuxBeginnings/Ubuntu-Hyprland.git ~/Ubuntu-Hyprland
cd ~/Ubuntu-Hyprland
chmod +x install.sh
./install.sh
```

> Branch examples: `24.04`, `26.04`

```bash
git clone --depth=1 -b 26.04 https://github.com/LinuxBeginnings/Ubuntu-Hyprland.git ~/Ubuntu-Hyprland
```

```bash
git clone --depth=1 -b 24.04 https://github.com/LinuxBeginnings/Ubuntu-Hyprland.git ~/Ubuntu-Hyprland
```

### πŸ’₯ πŸ’₯ UNINSTALL SCRIPT / Removal of Config Files

- 11 March 2025, due to popular request, created a guided `uninstall.sh` script. USE this with caution as it may render your system unstable.
- I will not be responsible if your system breaks
- The best still to revert to previous state of your system is via timeshift of snapper

### ❇️ Nvidia Drivers & πŸ”” NOTICE TO NVIDIA OWNERS

- If you choose to configure nvidia, driver will be installed via automatic detection / install. See [NVIDIA guide](https://documentation.ubuntu.com/server/how-to/graphics/install-nvidia-drivers/index.html#installing-the-drivers-for-generic-use-e-g-desktop-and-gaming)
- The command will be executed will be `sudo ubuntu-drivers install`
- Note that `nouveau` is installed, you need to uninstall it first or DO NOT choose to configure `nvidia`
- NOTE: that script is also designed to install some other nvidia stuff including blacklist of nouvea. Verify and review `install-scripts/nvidia.sh` or DO not choose to configure nvidia on the option

> [!IMPORTANT]
> If you want to use `nouveau` driver, don't choose `nvidia` in the option. This is because the nvidia installer part, it will blacklist `nouveau`. Hyprland will still be installed but it will skip blacklisting nouveau.

#### ✨ for ZSH and OH-MY-ZSH installation

> installer should auto change your default shell to zsh. However, if it does not, do this

```bash
chsh -s $(which zsh)
zsh
source ~/.zshrc
```

- reboot or logout
- by default `agnosterzak` theme is installed. Which is from external oh-my-zsh theme. You can find more themes from this [`OH-MY-ZSH-THEMES`](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes)
- to change the theme, `SUPER SHIFT O` , choose desired theme, and close and open terminal.
- or manually edit `~/.zshrc` . Look for ZSH_THEME="desired theme"

#### ✨ TO DO once installation done and dotfiles copied

- SUPER H for HINT or click on the waybar HINT! Button
- Head over to [FAQ](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/FAQ) and [TIPS](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/TIPS)

- if you installed in your laptop and Brightness and Keyboard brightness does not work you can execute this command `sudo chmod +s $(which brightnessctl)`

#### ✨ Packages that are manually downloaded and build. These packages will not be updated by apt and have to be manually updated

- Asus ROG asusctl [`LINK`](https://gitlab.com/asus-linux/asusctl) and `superfxctl` [`LINK`](https://gitlab.com/asus-linux/supergfxctl)
- swww [`LINK`](https://github.com/Horus645/swww)
- hyprland [`LINK`](https://github.com/hyprwm/)
- rofi-wayland [`LINK`](https://github.com/lbonn/rofi)

> [!TIP]
> To update to the latest packages, re-running this script will auto update all. Script is configured to pull latest packages build for you.

#### 🀬 FAQ

#### Most common question I got is, Hey Ja, Why the heck it is taking long time to install? Other distro like Arch its only a minute or two. Why here takes like forever?!?!?!

- Well, some packages are downloaded, built and compiled from SOURCE. Unlike Other distros, they already have prepacked binary that can just download and install.

> [!NOTE]
> This script does not setup audio. Kindly set up. If you have not, I recommend pipewire. `sudo apt install -y pipewire`

#### 🎞️ AGS Overview DEMO

- In case you are wondering, here is a short demo of AGS overview [Youtube LINK](https://youtu.be/zY5SLNPBJTs)
> Note: AGS overview for most distros has been replaced by `quickshell overview` Same keybinding and features.
> AGS v1 is no longer support and the AGS overview wasn't ported

#### ✨ TO DO once installation done and dotfiles copied

- SUPER H for HINT or click on the waybar HINT! Button
- Head over to [KooL Hyprland WIKI](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki)

#### πŸ™‹ Got a questions regarding the Hyprland Dots or configurations? πŸ™‹

- Head over to wiki Link [`WIKI`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki)

#### ⌨ Keybinds

- Keybinds [`CLICK`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Keybinds)

> [!TIP]
> KooL Hyprland has a searchable keybind function via rofi. (SUPER SHIFT K) or right click the `HINTS` waybar button

## πŸ›Ž **_ DEBIAN and UBUNTU Hyprland Dots UPDATING NOTES _**

> [!IMPORTANT]
> This is very Important for Debian and Ubuntu Dots

- With support for Hyprland v0.54+ the standard dotfiles are compatible.

#### πŸ™‹ πŸ‘‹ Having issues or questions?

- for the install part, kindly open issue on this repo
- for the Pre-configured Hyprland dots / configuration, submit issue [`here`](https://github.com/LinuxBeginnings/Hyprland-Dots/issues)

#### πŸ”§ Proper way to re-installing a particular script from install-scripts directory

- CD into Ubuntu-Hyprland directory and then ran the below command.
- i.e. `./install-scripts/gtk-themes.sh` - For reinstall GTK Themes or
- `./install-scripts/sddm.sh` - To re-install sddm
> [!IMPORTANT]
> DO NOT cd into `install-scripts` directory as scripts will fail!

#### ❗ some known issues for nvidia

- reports from members of my discord, states that some users of nvidia are getting stuck on sddm login. credit to @Kenni Fix stated was

```
while in sddm press ctrl+alt+F2 or F3
log into your account
`lspci -nn`, find the id of your nvidia card
`ls /dev/dri/by-path` find the matching id
`ls -l /dev/dri/by-path` to check where the symlink points to
)
```

- add "env = WLR_DRM_DEVICES,/dev/dri/cardX" to the ENVvariables config `~/.config/hypr/UserConfigs/ENVariables.conf` ; X being where the symlink of the gpu points to

- more info from the hyprland wiki [`Hyprland Wiki Link`](https://wiki.hyprland.org/FAQ/#my-external-monitor-is-blank--doesnt-render--receives-no-signal-laptop)

- reports from a member of discord for Nvidia for additional env's
- remove # from the following env's on

```
env = GBM_BACKEND,nvidia-drm
env = WLR_RENDERER_ALLOW_SOFTWARE,1
```

#### πŸ«₯ Improving performance for Older Nvidia Cards using driver 470

- [`SEE HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/discussions/123#discussion-6035205)

#### ❗ other known issues

> [!NOTE]
> Auto start of Hyprland after login (no SDDM or GDM or any login managers)

- [ ] This was disabled a few days ago. (19 May 2024). This was because some users, after they used the Distro-Hyprland scripts with other DE (gnome-wayland or plasma-wayland), if they choose to login into gnome-wayland for example, Hyprland is starting.
- [ ] to avoid this, I disabled it. You can re-enable again by editing `~/.zprofile` . Remove all the `#` on the first line
- [ ] ROFI issues (scaling, unexplained scaling etc). This is most likely to experience if you are installing on a system where rofi is currently installed. To fix it uninstall rofi and install rofi-wayland . `sudo apt autoremove rofi` .
- Install `rofi`

```bash
cd ~/Ubuntu-Hyprland
./install-scripts/rofi-wayland.sh
```

- [ ] Rofi-wayland is compatible with x11 so no need to worry.
- After ubuntu 24.04, the package name is just `rofi` 24.04 currently still needs `rofi-wayland`
- [ ] Does not work in Ubuntu 23.10 and older
- [ ] sddm blackscreen when log-out
- [ ] Installing SDDM if or any other Login Manager installed. See [`Issue 2 - SDDM`](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/issues/2)
- [ ] network is down or become unmanaged [`This`](https://askubuntu.com/questions/71159/network-manager-says-device-not-managed) might help
- [ ] See note above about Hyprland-Dots newer version incompatibility

#### πŸ“’ Final Notes

- join my discord channel [`Discord`](https://discord.gg/RZJgC7KAKm)
- Feel free to copy, re-distribute, and use this script however you want. Would appreciate if you give me some loves by crediting my work :)

#### ✍️ Contributing

- As stated above, these script does not contain actual config files. These are only the installer of packages
- If you want to contribute and/or test the Hyprland-Dotfiles (development branch), [`Hyprland-Dots-Development`](https://github.com/LinuxBeginnings/Hyprland-Dots/tree/development)
- Want to contribute on KooL-Hyprland-Dots Click [`HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute
- Want to contribute on This Installer? Click [`HERE`](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/blob/main/CONTRIBUTING.md) for a guide how to contribute

#### πŸ‘πŸ‘πŸ‘ Thanks and Credits!

- [`Hyprland`](https://hyprland.org/) Of course to Hyprland and @vaxerski for this awesome Dynamic Tiling Manager.

### πŸ’– Support

- a Star on my Github repos would be nice 🌟

- Subscribe to my Youtube Channel [YouTube](https://www.youtube.com/@Ja.KooLit)

#### πŸ“Ή Youtube videos (Click to view and watch the playlist) πŸ“Ή

[![Youtube Playlist Thumbnail](https://raw.githubusercontent.com/LinuxBeginnings/screenshots/main/Youtube.png)](https://youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx&si=iaNjLulFdsZ6AV-t)