This guide will walk you through setting up and using this configuration.
Before using this config, you need to install the basic ML4W Hyprland setup.
First, clone the hyprland-starter repository created by @mylinuxforwork:
git clone [email protected]:mylinuxforwork/hyprland-starter.gitNavigate to the cloned directory and run the setup script:
cd hyprland-starter
./setup.shThis will install the basic ML4W Hyprland environment on your system.
After the basic installation, navigate to the hypr directory in this repository and run the install script with the help flag to see available options:
cd hypr
./install.sh helpThis will show you what configuration options are available and how to use the installation script.
Once you've reviewed the available options, copy the desired config folder directly into your .config directory:
# Replace 'desired-config-folder' with the actual folder name you want to use
cp -r desired-config-folder ~/.config/After completing these steps, your configuration should be active. You may need to:
- 🔄 Log out and log back in
- 🔃 Restart your Hyprland session
- ✅ Check that all dependencies are properly installed
🛠️ Click to explore the included tools and configurations
This configuration includes custom setups for various tools that work together to create a cohesive Hyprland desktop environment:
hypr/- Main Hyprland window manager configuration- Custom keybindings, window rules, and animations
- Scripts for automation and window management
- Hyprlock (screen locker) and Hyprpaper (wallpaper) configs
waybar/- Highly customized status bar- System monitoring modules (CPU, RAM, disk usage)
- Custom scripts for dynamic information display
- Responsive design for different monitor setups
rofi/- Stylized application launcher and menu system- Custom themes and color schemes
- Enhanced search functionality
wlogout/- Elegant logout/shutdown menu for Wayland
alacritty/- GPU-accelerated terminal emulator- Optimized performance settings
- Custom color schemes and fonts
kitty/- Feature-rich terminal with advanced capabilities- Tab management and layout configurations
- Custom key mappings
nvim/- Highly customized Neovim setup (stolen from @m-brl 😄)- Extensive plugin configuration
- Custom keybindings and workflow optimizations
- Language server configurations
dunst/- Lightweight notification daemon- Custom notification styling and behavior
- Integration with system events
superfile/- Modern terminal file manager- Enhanced file navigation and management
- Custom themes and shortcuts
fum/- Fast file finder and management toolml4w*/- ML4W specific configurations and themes- Integration with the ML4W ecosystem
- Custom themes and styling
All configurations are designed to work harmoniously together, featuring:
- 🌈 Consistent color schemes across all applications
- 🎯 Optimized keybindings that don't conflict
- 📱 Responsive layouts for different screen sizes
- ⚡ Performance-oriented configurations
- 🔧 Easy customization and extensibility
This configuration embraces a clean, minimalist ASCII art aesthetic throughout all config files. The design philosophy includes:
- Header Banners - Each major config file features elegant ASCII art headers (like the "Hyprland" banner in
hypr/hyprland.conf) - Consistent Commenting Style - Structured comment blocks with ASCII separators for better organization
- Visual Hierarchy - ASCII art helps create clear sections and improves code readability
- Brand Identity - Custom ASCII logos and headers give the configuration a professional, cohesive look
The ASCII art serves both functional and aesthetic purposes:
- 📋 Organization - Makes config files easier to navigate and understand
- 🎨 Personality - Adds character and personal touch to otherwise dry configuration files
- 🔍 Quick Identification - Instantly recognizable headers help identify different config sections
- 💫 Professional Touch - Clean, well-structured ASCII art demonstrates attention to detail
The ASCII art direction reflects a balance between functionality and visual appeal, making the configuration both beautiful and practical.
If you encounter any issues:
- ✔️ Make sure the ML4W Hyprland starter was installed successfully
- 🔍 Verify that all required dependencies are installed
- 📂 Check that the config files were copied to the correct location in
~/.config/ - 📚 Refer to the help output from
./install.sh helpfor additional guidance
- @mylinuxforwork (Stephan Raabe) - Creator of the amazing ML4W Hyprland starter
- @m-brl (Mathieu) - Friend whose nvim config I shamelessly stole 😄
- @charlesmadjeri (Charles) - A "Friend" who "helped" me create the prompt for this readme
For additional help or questions about this configuration, please refer to the documentation or create an issue in this repository.
Made with ❤️ using the awesome work from the Hyprland and ML4W communities