Skip to content

README.md

Latest commit

 

History

History
91 lines (71 loc) · 3.27 KB

README.md

File metadata and controls

91 lines (71 loc) · 3.27 KB

Dotfiles

My personal dotfiles for Hyprland-based Wayland environment.

📦 Main Components

  • Window Manager: Hyprland - Dynamic tiling Wayland compositor
  • Terminal: Kitty - Fast, feature-rich GPU-accelerated terminal
  • Shell: Zsh + Starship - Powerful shell with custom prompt
  • Editor: Neovim + Zed - Modern editors for different needs
  • Launcher: Rofi - Application launcher and window switcher
  • Status Bar: Waybar - Customizable Wayland status bar
  • Notifications: Dunst - Lightweight notification daemon
  • File Manager: Yazi - Blazing fast terminal file manager
  • Version Control: Jujutsu - Git-compatible VCS
  • Shell Scripting: Ashell - POSIX-compliant shell scripting library

🚀 Installation

# Clone the repository
git clone <your-repo-url> ~/.dotfiles
cd ~/.dotfiles

# Run the deployment script
python3 mxbin/deploy.py

The deployment script will create symlinks from ~/.dotfiles to the appropriate locations in your home directory.

📁 Project Structure

.
├── ashell/          # Ashell shell scripting configuration
├── dunst/           # Notification daemon config
├── hypr/            # Hyprland configs (main, plugins, launcher, lock)
├── jj/              # Jujutsu version control config
├── kitty/           # Kitty terminal emulator config
├── latexmkrc        # LaTeX compilation settings
├── mxbin/           # Custom shell scripts
├── nvim/            # Neovim configuration
├── rofi/            # Rofi launcher themes and configs
├── starship/        # Starship prompt configuration
├── waybar/          # Waybar status bar config
├── yazi/            # Yazi file manager config
├── zed/             # Zed editor settings
└── zsh/             # Zsh shell configuration

🛠️ Custom Scripts (mxbin)

  • deploy.py - Symlink deployment script
  • screenShot.sh - Screenshot tool
  • clipboard.sh - Clipboard manager
  • gamemode.sh - Game mode toggle
  • swytch.sh - Window/workspace switcher
  • waybarCava.sh - Audio visualizer for Waybar
  • caps_use_for_shurufa.sh - Caps Lock remapping for input methods
  • chwp - Wallpaper changer
  • jy - Utility script

⚙️ Configuration Details

Hyprland

  • Located in hypr/
  • Contains main config, plugins, launcher, and lock screen settings
  • Sub-configs for bindings, colors, executables, and window rules

Neovim

  • LazyVim-based configuration
  • Located in nvim/
  • See nvim/README.md for editor-specific details

Kitty

  • Multiple theme support (current, dank)
  • Located in kitty/

Waybar

  • Custom styled status bar with modules
  • Located in waybar/

📝 Notes

  • Configuration files are managed via symbolic links
  • Existing files will not be overwritten (check deployment script output)
  • Tested on Arch Linux with Wayland session

📄 License

MIT