A personal, fully-automated setup for quickly bootstrapping a workable, user-friendly Niri environment on Void Linux—from scratch to daily-driver in minutes.
This repo is the toolkit and documentation I use to standardize and streamline my Void Linux installs, with an emphasis on a reliable Niri Wayland compositor experience. Documentation around Void and Niri can be hard to piece together—this repo aims to be a reproducible, well-documented reference both for myself and for anyone else struggling to get a modern desktop running on Void.
Important: This repository and its scripts have been developed, tested, and tailored exclusively for systems with a dual-GPU configuration featuring an NVIDIA discrete GPU (dGPU) and an Intel integrated GPU (iGPU).
Other hardware or single GPU configurations are currently not supported and may not work correctly with this setup.
If you have a different GPU setup or find issues, this repo might not meet your needs yet.
Contributions and collaboration are warmly welcomed to help extend support for other configurations and improve overall compatibility.
Please open an issue or pull request if interested!
- Display Manager: SDDM (with Astronaut theme)
- Compositor: Niri Wayland compositor
- Status Bar: Waybar
- Application Launcher / Picker: Walker
- Terminal Emulator: Alacritty
- Editor: Neovim (nvim)
- Browser: Ungoogled Chromium
- Terminal Multiplexer: tmux
The only manual setup required (outside this repo) is having a bootable USB created with Ventoy or an equivalent tool, containing the official Void Linux minimal glibc live ISO image downloaded from voidlinux.org/download.
The manual installation process assumes Windows+Void dual boot users have manually created a Windows boot partition sized at least 1 GiB (1024 MiB) to avoid the Windows automatic smaller boot partition issue. See the Arch Wiki Dual Boot with Windows for detailed partition layout guidance.
After the minimal Void installation, the rest of the environment setup including Niri is fully automated via install.sh and related scripts.
Scripts reflect an actual, working daily setup—no partial configs or abandoned dotfiles.
Organized configs and scripts demonstrate best practices; works as a learning resource for users new to Void or Niri.
- Consistent Void Linux environment ready for daily development and desktop use.
- Fully configured (Niri) Wayland compositor with all major dependencies.
- Sensible scripting for SDDM, networking, display, font, backlight/RGB device rules, and more.
- Step-by-step, plain-English documentation in this repo, augmented by the detailed partition setup guidance in Arch Wiki.
Anyone who:
- Wants to replicate a stable Niri-based Wayland desktop on Void Linux, either from scratch or for rapid migration.
- Is dual booting with Windows and wants consistent guidance on boot partition setup.
- Is tired of piecing together outdated forum posts and missing config fragments.
- Prefers automation, clarity, and ongoing maintainability—especially for their own systems, but also for friends or colleagues.
Contributions, feedback, and ideas are warmly welcomed!
Please review the CONTRIBUTING.md guide before opening issues or pull requests. It outlines this project's:
- Branching and commit message conventions
- Script and installer standards
- Testing expectations for bare-metal and VM setups
- Workflow for proposing and reviewing changes
Following these ensures the repo remains clean, consistent, and reproducible for everyone.
Do not follow this README for step-by-step instructions!
Please see INSTALLATION.md for comprehensive installation and configuration steps.
Everything you need beyond the minimal OS install and partition setup is automated and handled through scripts in this repo.
This project is licensed under the MIT License - see the LICENSE file for details.