Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jakoolit/nixos-hyprland

To Automate Installation of Hyprland on NixOS using flakes. NOTE: Dot configs are not written in Nix.
https://github.com/jakoolit/nixos-hyprland

hyprland hyprland-config hyprland-rice nixos nixos-config rice rofi rofi-config rofi-menus rofi-theme rofi-wayland swww wallust waybar wayland

Last synced: 4 days ago
JSON representation

To Automate Installation of Hyprland on NixOS using flakes. NOTE: Dot configs are not written in Nix.

Host: GitHub
URL: https://github.com/jakoolit/nixos-hyprland
Owner: JaKooLit
Created: 2024-09-04T10:34:41.000Z (29 days ago)
Default Branch: main
Last Pushed: 2024-09-26T12:22:43.000Z (7 days ago)
Last Synced: 2024-09-29T07:23:20.529Z (4 days ago)
Topics: hyprland, hyprland-config, hyprland-rice, nixos, nixos-config, rice, rofi, rofi-config, rofi-menus, rofi-theme, rofi-wayland, swww, wallust, waybar, wayland
Language: Nix
Homepage:
Size: 58.8 MB
Stars: 23
Watchers: 1
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

Read this First
Auto Install
Manual Install
Reverting to your previous config

## 💌 ** JaKooLit's ❄️ NixOS-Hyprland Install Script ** 💌

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

👇 KOOL's Hyprland-Dots related Links 👇

Hyprland-Dots repo
Youtube
Wiki
Keybinds
FAQ
Discord

KooL Hyprland-Dotfiles Showcase

https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/50d53755-0f11-45d6-9913-76039e84a2cd

> [!NOTE]
> This is not purely written in Nix-Language. You should check ZaneyOS. Link below

> [!NOTE]
> hyprland to be installed will be from development branch or known as -git version

#### 🪧🪧🪧 ANNOUNCEMENT 🪧🪧🪧
- This Repo does not contain Hyprland Dots or configs! Nor Configs are NOT written in Nix. Hyprland Dotfiles will be downloaded from [`KooL's Hyprland-Dots`](https://github.com/JaKooLit/Hyprland-Dots) .

- Hyprland-Dots use are constantly evolving / improving. you can check CHANGELOGS here [`Hyprland-Dots-Changelogs`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs)

- GTK Themes and Icons will be pulled from [`LINK`](https://github.com/JaKooLit/GTK-themes-icons) including Bibata Cursor Modern Ice

- the wallpaper offered to be downloaded towards the end are from this [`REPO`](https://github.com/JaKooLit/Wallpaper-Bank)

> [!IMPORTANT]
> take note of the requirements

### 👋 👋 👋 Requirements
- You must be running on NixOS.
- Minimum space is 40gb. 60gb recommended as NixOS is a space hungry distro
- Must have installed NIXOS using GPT & UEFI. Systemd-boot is configured as default bootloader, for GRUB users, you need to edit `hosts/default/config.nix` before installing
- Manually edit your host specific files. The host is the specific computer your installing on.

#### 🖥️ Multi Host & User Configuration
- You can now define separate settings for different host machines and users!
- Easily specify extra packages for your users in the users.nix file.
- Easy to understand file structure and simple, but encompassing, configuratiion.

#### 📦 How To Install Packages?
- You can search the [Nix Packages](https://search.nixos.org/packages?) & [Options](https://search.nixos.org/options?) pages for what a package may be named or if it has options available that take care of configuration hurdles you may face.
- Then edit `hosts//config.nix` and/or `hosts//user.nix` . Config.nix is system-wide changes / packages and user.nix is only available to that user.
- Once you edit, ran `sudo nixos-rebuild switch --flake .#` NOTE. omit < > and ensure you are in directory where your flake.nix is.

#### 🙋 Having Issues / Questions?
- Please feel free to raise an issue on the repo, please label a feature request with the title beginning with [feature request], thank you!
- If you have a question about KooL's Hyprland dots, see [`KooL's Dots WIKI`](https://github.com/JaKooLit/Hyprland-Dots/wiki) . In that wiki are some tips, keybinds, some collective FAQ etc.

### ⬇️ Installations
#### 📽 Youtube video for using this script
- [KooL's Hyprland Dots on NixOS](https://youtu.be/nJLnRgnLPWI)

#### 📜 1. Using auto install Script:
- This is the easiest and recommended way of starting out.
- This script is NOT meant to allow you to change every option that you can in the flake or help you install extra packages. It is simply here so you can get my configuration installed with as little chances of breakages and then fiddle to your hearts content!
- Simply copy this and run it:
```
nix-shell -p git vim curl pciutils
sh <(curl -L https://github.com/JaKooLit/NixOS-Hyprland/raw/main/auto-install.sh)
```
> [!NOTE]
> pciutils is necessary to detect if you have nvidia card.

#### 🦽 2. Manual:

Click here 👉🏻 Manual Installation

- Run this command to ensure git, curl, vim & pciutils are installed: Note: or nano if you prefer nano for editing
```
nix-shell -p git vim curl pciutils
```
- Clone this repo & CD into it:
```
git clone --depth 1 https://github.com/JaKooLit/NixOS-Hyprland.git ~/NixOS-Hyprland
cd ~/NixOS-Hyprland
```
- *You should stay in this folder for the rest of the install*
- Create the host folder for your machine(s)
```
cp -r hosts/default hosts/
```
- Edit as required the `config.nix` in `hosts//`
- Generate your hardware.nix like so:
```
sudo nixos-generate-config --show-hardware-config > hosts//hardware.nix
```
- Run this to enable flakes and install the flake replacing hostname with whatever you put as the hostname:
```
NIX_CONFIG="experimental-features = nix-command flakes"
sudo nixos-rebuild switch --flake .#hostname
```

Once done, you can install the GTK Themes and Hyprland-Dots. Links are above

#### 👉🏻 3. Alternative
- auto install by running `./install.sh` after cloning and CD into NixOS-Hyprland
> [!NOTE]
> install.sh is a stripped version of auto-install.sh as it will not re-download repo

- Run this command to ensure git, curl, vim & pciutils are installed: Note: or nano if you prefer nano for editing
```
nix-shell -p git curl pciutils
```

- Clone this repo into your home directory & CD into it:
```
git clone --depth 1 https://github.com/JaKooLit/NixOS-Hyprland.git ~/NixOS-Hyprland
cd ~/NixOS-Hyprland
```

> [!IMPORTANT]
> need to download in your home folder as some part of the installer are going back again to ~/NixOS-Hyprland

- *You should stay in this folder for the rest of the install*
- edit `hosts/default/config.nix` to your liking. Once you are satisfied, ran `./install.sh`

Now when you want to rebuild the configuration you have access to an alias called flake-rebuild that will rebuild the flake!

Hope you enjoy! 🎉

#### 💔 known issues 💔
- GTK themes and Icons including cursor not applied automatically. gsettings does not seem to work
- You can set the GTK Themes, icons and cursor using nwg-look

#### 🪤 My NixOS configs
- on this repo [`KooL's NIXOS Configs`](https://github.com/JaKooLit/NixOS-configs)

#### ⌨ Keybinds
- Keybinds [`CLICK`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds)
> [!TIP]
> KooL's Dots v2.3.7 has a searchable keybind function via rofi. (SUPER SHIFT K) or right click the `HINTS` waybar button

#### 🫥 Improving performance for Older Nvidia Cards using driver 470
- [`SEE HERE`](https://github.com/JaKooLit/Hyprland-Dots/discussions/123#discussion-6035205)

### 🔙 Reverting back to your default configs
- if you use flakes, you can just simply locate your default or previous configs. CD into it and execute `sudo nixos-rebuild switch --flake .#`
- if you dont have flakes enabled previous, simply running `sudo nixos-rebuild switch` will revert you to your default configs from `/etc/nixos/`
- ⚠️ just remember to clean up your nix/store to remove unnessary garbage from your system `sudo nix-collect-garbage -d`
- OR, simply just revert into your previous snapshot of your system by choosing which snapshot to boot via your bootloaders.

#### 📒 Final Notes
- join my discord channel [`Discord`](https://discord.com/invite/9JEgZsfhex)
- 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/JaKooLit/Hyprland-Dots/tree/development)

#### 👍👍👍 Thanks and Credits!
- [`Hyprland`](https://hyprland.org/) Of course to Hyprland and @vaxerski for this awesome Dynamic Tiling Manager.
- [`ZaneyOS`](https://gitlab.com/Zaney/zaneyos) - template including auto installation script and idea. ZaneyOS is a NixOS-Hyprland with home-manager. Written in pure nix language

## 💖 Support
- a Star on my Github repos would be nice 🌟

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

- You can also buy me Coffee Through ko-fi.com or Coffee.com 🤩

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/JaKooLit)

#### 📹 Youtube videos (Click to view and watch the playlist) 📹
[![Youtube Playlist Thumbnail](https://raw.githubusercontent.com/JaKooLit/screenshots/main/Youtube.png)](https://youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx&si=iaNjLulFdsZ6AV-t)

## 🥰🥰 💖💖 👍👍👍
[![Stargazers over time](https://starchart.cc/JaKooLit/NixOS-Hyprland.svg?variant=adaptive)](https://starchart.cc/JaKooLit/NixOS-Hyprland)