Skip to content

INSTALLATION.md

Latest commit

 

History

History
196 lines (136 loc) · 7.02 KB

INSTALLATION.md

File metadata and controls

196 lines (136 loc) · 7.02 KB
Raw

BlackNode Banner

BlackNode // Installation Guide

stars   forks   issues   last commit   license  

git clone https://github.com/zhaleff/BlackNode.git $HOME/BlackNode
cd $HOME/BlackNode

Important

BlackNode targets Arch Linux. It may work on derivatives but this has not been tested.

BlackNode requires Hyprland 0.55+ (Lua config). Install the core packages:

# Official repos
sudo pacman -S --needed \
  hyprland waybar rofi-wayland kitty alacritty neovim \
  dunst hyprlock hypridle fastfetch yazi zsh fzf \
  matugen sddm gtk3 gtk4 ttf-jetbrains-mono nerd-fonts

# AUR helper
git clone https://aur.archlinux.org/yay.git /tmp/yay
cd /tmp/yay && makepkg -si --noconfirm && cd -

# AUR packages
yay -S --needed wlogout clipse-bin powerlevel10k-git

Tip

If you already have these packages, skip straight to step 3.

The linkdots script creates symlinks from BlackNode/Configs/ to ~/.config/ and ~/.local/bin/. Existing files are backed up automatically.

bash Scripts/linkdots.sh

What it does:

  1. Backs up existing ~/.config/* and ~/.local/bin/* files to ~/.config/blacknode-backup-<timestamp>/
  2. Symlinks every directory in Configs/.config/ to ~/.config/
  3. Symlinks every file in Configs/.local/bin/ to ~/.local/bin/
  4. Skips entries that are already correctly linked

Warning

This overwrites your existing configs. Backup is automatic, but make sure you know what you are replacing.

What Gets Linked

~/.config/
├── hypr/          → Hyprland 0.55+ Lua config (keybinds, rules, input, overrides)
├── rofi/          → M3-themed launcher, bn-menu, sidebar scripts, shared themes
├── waybar/        → 3 bar styles (Classic, Hacking, Minimal)
├── kitty/         → Terminal with Catppuccin theme
├── alacritty/     → Terminal (optional)
├── dunst/         → M3 notification daemon
├── wlogout/       → Logout screen
├── fastfetch/     → M3 two-box fetch
├── zsh/           → Plugins, aliases, completions
├── nvim/          → Neovim config
├── yazi/          → File manager
├── cava/          → Audio visualiser
├── clipse/        → Clipboard manager
├── matugen/       → Colour generation templates
├── qt5ct/         → Qt5 theming
├── powerlevel10k/ → Prompt config
├── grub/          → Bootloader theme
└── sddm/          → M3 login manager

~/.local/bin/
├── bn-menu        → Main hub launcher
├── scripts/       → Submenus (system, audio, bluetooth, etc.)
└── *.sh           → Utility scripts (brightness, volume, media, weather, etc.)

Set your wallpaper

Place wallpapers in ~/Pictures/Wallpapers/ and run:

# Opens wallpaper selector
SUPER + W

Or manually:

~/.config/rofi/scripts/wallselect.sh

Matugen generates the M3 colour palette from your wallpaper automatically.

Keybind reference

Binding Action
SUPER + SPACE bn-menu (main hub)
SUPER + R App launcher
SUPER + SHIFT + O BlackNode Dashboard
SUPER + N Notification centre
SUPER + V Quick Config HUD
SUPER + D Kitty terminal
SUPER + E Dolphin file manager
SUPER + Q Close focused window
SUPER + SHIFT + X Power menu

Full list: KEYBINDS.md

Note

If the keyboard layout does not match your hardware, edit ~/.config/hypr/settings/input.lua and change kb_layout then run hyprctl reload.

Hyprland does not start

Ensure your GPU is supported and you are launching from a TTY with Hyprland (not hyprland). Both SDDM and TTY login should work.

Rofi themes look wrong

Run matugen on a wallpaper to regenerate the colour palette:

matugen image ~/Pictures/Wallpapers/your-wallpaper.jpg

bn-menu not found

You may need to run linkdots to create the symlink:

bash Scripts/linkdots.sh

Restoring your old configs

The backup is at ~/.config/blacknode-backup-<timestamp>/. Restore individual files or entire directories from there.

Made with ♥ by zhaleff

Happy configuring.

Last edited: 2026