Skip to content

ahmad9059/HyprFlux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

HyprFlux

HyprFlux

License: MIT Arch Linux Hyprland Shell Script GitHub stars GitHub forks

A comprehensive collection of dotfiles and configurations for creating a beautiful, efficient Hyprland desktop environment on Arch Linux

πŸš€ Quick Install β€’ πŸ“Έ Screenshots β€’ πŸ”§ Features β€’ πŸ“– Documentation β€’ 🀝 Contributing


🌐 Website

For detailed documentation and preferences, visit: https://hyprflux.dev

🌟 Overview

HyprFlux is a meticulously crafted collection of configuration files designed to transform your Arch Linux installation into a stunning, productive desktop environment. Built around the modern Hyprland compositor, it provides a seamless blend of aesthetics and functionality.

πŸ“Έ Screenshots

Desktop Overview

1 10

2 3
4 5
6 7

✨ What Makes HyprFlux Special?

  • 🎨 Beautiful Design: Carefully curated themes and color schemes
  • ⚑ Performance Optimized: Lightweight and fast configurations
  • πŸ”§ Fully Automated: One-command installation with intelligent setup
  • 🎯 Developer Focused: Optimized for productivity and development workflows
  • 🌈 Customizable: Easy to modify and extend according to your preferences

πŸ“‹ Requirements

System Requirements

  • Operating System: Arch Linux (minimal installation recommended)
  • Architecture: x86_64
  • Memory: Minimum 4GB RAM (8GB+ recommended)
  • Storage: At least 10GB free space
  • Network: Active internet connection for package downloads

Prerequisites

  • Fresh Arch Linux installation with minimal profile
  • Basic system utilities (curl, git, sudo)
  • User account with sudo privileges

πŸš€ Quick Installation

One-Line Magic Command

sh <(curl -fsSL https://hyprflux.dev/install)

⚠️ Important: This script will modify your system configuration. Make sure to backup any existing dotfiles before proceeding.

Installation Process

  1. Run the installation command - The script will automatically download and execute
  2. Enter sudo password when prompted
  3. Follow the interactive setup - Select your preferred options:

Installation Options

πŸ”§ Recommended Installation Options

Essential Components (Recommended):

  • βœ… sddm - Display manager for login screen
  • βœ… sddm_theme - Beautiful custom SDDM theme
  • βœ… gtk_themes - GTK theme integration
  • βœ… bluetooth - Bluetooth support
  • βœ… thunar - File manager
  • βœ… xdph - Desktop portal for Hyprland
  • βœ… zsh - Enhanced shell with Oh My Zsh
  • βœ… dots - Core dotfiles and configurations

Optional Components:

  • QuickShell - QuickShell for Desktop-Like Overview
  • Pokemon - Add Pokemon color scripts to your terminal
  • Rog - Download and Install Pre-configured for ROG Laptops

πŸ“ Interactive Configuration

During installation, you'll be prompted to configure:

Setting Options Description
Keyboard Layout Various layouts Select your preferred keyboard layout
Text Editor nano, nvim, vim Choose your default terminal editor
Hyprlock Resolution Multiple resolutions Set lock screen resolution
Clock Format 12h / 24h Choose time display format
SDDM Wallpaper Multiple options Select login screen background
Extra Wallpapers Yes / No Download additional wallpapers (~1GB)

πŸ” Authentication Notes

The installer will request sudo password 2-3 times during the process:

  • Once for initial system setup
  • Once for Zsh configuration
  • Once for wallust installation
  • Additional prompts for optional packages

🎨 Features

πŸ–₯️ Desktop Environment

  • Hyprland: Modern Wayland compositor with smooth animations
  • Waybar: Highly customizable status bar
  • Rofi: Application launcher and window switcher
  • SDDM: Beautiful login manager with custom theme

🎨 Theming & Aesthetics

πŸ› οΈ Development Tools

  • Neovim: Fully configured with plugins and LSP support
  • Tmux: Terminal multiplexer with custom layouts
  • Zsh: Enhanced shell with Oh My Zsh and custom theme
  • Git Integration: Pre-configured Git settings

πŸ“± Applications & Utilities

🌐 Web Applications

Automated setup of Progressive Web Apps (PWAs) for:

πŸ”§ Post-Installation

First Boot

After installation completes:

  1. Reboot your system when prompted
  2. Login through SDDM with your user credentials
  3. Enjoy your new desktop environment!

Customization

  • Wallpapers: Located in ~/Pictures/wallpapers/
  • Configurations: Found in ~/.config/
  • Themes: Available in ~/.themes/
  • Backup: Original configs backed up to ~/dotfiles_backup/

πŸ“– Documentation

πŸ—‚οΈ Project Structure

HyprFlux/
β”œβ”€β”€ .config/                 # Application configurations
β”‚   β”œβ”€β”€ hypr/               # Hyprland configuration
β”‚   β”œβ”€β”€ waybar/             # Status bar configuration
β”‚   β”œβ”€β”€ rofi/               # Application launcher
β”‚   └── ...
β”œβ”€β”€ .themes/                # GTK themes
β”œβ”€β”€ wallpapers/             # Wallpaper collection
β”œβ”€β”€ utilities/              # Additional tools and themes
β”œβ”€β”€ install.sh              # Main installation script
β”œβ”€β”€ dotsSetup.sh           # Dotfiles setup script
└── README.md              # This file

πŸ”§ Key Configuration Files

  • ~/.config/hypr/hyprland.conf - Hyprland window manager settings
  • ~/.config/waybar/config - Status bar configuration
  • ~/.config/rofi/config.rasi - Application launcher styling
  • ~/.zshrc - Zsh shell configuration
  • ~/.tmux.conf - Terminal multiplexer settings

Getting Help

🀝 Contributing

We welcome contributions! Here's how you can help:

πŸ› Reporting Bugs

  1. Check existing issues
  2. Create a new issue with detailed information
  3. Include system information and error logs

πŸ’‘ Suggesting Features

  1. Open a feature request issue
  2. Describe the feature and its benefits
  3. Provide implementation ideas if possible

πŸ”§ Code Contributions

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature-name
  3. Make your changes and test thoroughly
  4. Submit a pull request with detailed description

πŸ“ Documentation

  • Improve README and documentation
  • Add configuration examples
  • Create tutorials and guides

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

Special thanks to:

  • Hyprland Community - For the amazing compositor
  • Arch Linux Team - For the robust foundation
  • Open Source Contributors - For the tools and themes used
  • Community Members - For feedback and contributions

πŸ“Š Project Stats

GitHub repo size GitHub last commit GitHub issues GitHub pull requests


Made with ❀️ by ahmad9059

⭐ Star this repository if you found it helpful! ⭐

Releases

No releases published

Packages

No packages published