🌿 ‎ About

Hey there! 👋

This is my personal dotfiles repository.

I created this repo to help me backup my config files and to easily deploy them in a new machine with the help of Ansible and yadm. It has some files exclusive to my personal use (programming, gaming, etc) so it's not just a rice.

At first I didn't think about ricing but more and more, my focus has got into creating a good and aesthetic rice, with a lot of customization, as well as maintaining the easy deploy and use for my multiple machines.

If you wanna know how to install them, go to the setup section. There is a guided installation.

I've been working on this for a long time so I hope you like it!

✨ Features

• 🕶️ Dark Mode for the Whole System
• 💤 Neovim powered by LazyVim with Custom Extras Added (More than 200!)
• ☝️ Screenshot, Keybindings, Games, Clipboard, Color and Wallpaper Picker
• 🪟 Animations for nearly all the System
• 🔧 Modular Configuration
• 🖥️ AwesomeWM Workspace Behavior
• 📂 Following XDG Base Directory Standard
• 🚗 Automatic Mounting of USB Devices with Notification
• 📜 Scratchpads
• 💫 Beautiful Wallpapers
• 🤓 Shell Prompt with Nerd Icons
• ➕ Extra Hyprland Plugins
• 🌎 Custom Userchrome and Extension Configurations
• 🚀 Minimal VSCodium with Native Integration of your Neovim Setup
• 🦀 Rust Alternatives
• 🔔 Notification Center
• 🔊 Volume and Brightness OSD
• 🎨 Color Scripts for the Terminal
• 🔒 Idle and Lock apps
• ⚡ Performance Mode
• ⚙️ Various other Tweaks

---

🌸 Core System Info

The rice codename is Artemis 🏹, named after the Greek goddess of the hunt and the wild.

• OS: Arch Linux 💥
• WM: hyprland 🪟
• Shell: fish 🐚
• Terminal Emulator: kitty 🐱
• Panel: waybar 🍧
• Text Editor: neovim ⌨️
• App Launcher: rofi 🚀
• File Manager: yazi / nemo 📂
• Browser: Floorp 🌐
• Notification Manager: swaync 🔔
• Colorscheme: Catppuccin 🎨

---

🐧 Whole System Info

Here is all the information about my setup:

Note

Some of this apps have the config files included in the repo, which are marked with ⚙️. Also, my favorite are programs and tools are marked with 💖.

🐧 System

📚 Entry	✨ App
OS	💖 Arch Linux
Package Manager	pacman ⚙️
AUR Helper	💖 yay ⚙️
Display Manager	greetd (with tuigreet)
Window Manager	💖 hyprland ⚙️
Notification Daemon/Center	swaync ⚙️
OSD Popup	swayosd
Bar	💖 waybar ⚙️
Audio Daemon	pipewire
Application Launcher	💖 rofi ⚙️
Firewall	ufw
Clipboard Manager	wl-clipboard (with cliphist)
Wallpaper Switcher	swww
Lock Screen	hyprlock ⚙️
Idle Timeout	hypridle ⚙️
Color Picker	hyprpicker
Screenshot Tool	hyprshot (Using grim and slurp)
Image Annotation	satty ⚙️

🖥️ CLI/TUI Apps

📚 Entry	✨ App
Shell	💖 fish ⚙️
Terminal Emulator	💖 kitty ⚙️
Terminal Multiplexer	tmux ⚙️
Shell Prompt	starship ⚙️
Text Editor	💖 neovim ⚙️
Shell History	atuin ⚙️
CD Replacement	💖 zoxide
LS Replacement	eza
Cat Replacement	bat ⚙️
Find Replacement	fd ⚙️
File Manager	💖 yazi ⚙️
Help Pages	navi / TLDR ⚙️
Fuzzy File Finder	💖 fzf
Fuzzy Word Finder	ripgrep ⚙️
Git TUI	💖 lazygit ⚙️
Npm Manager TUI	lazynpm
Docker TUI	lazydocker
Arch Package Search TUI	pacseek ⚙️
Trash CLI	gtrash
Update Tool	topgrade ⚙️
Audio Visualizer	cava ⚙️
System Monitor	btop ⚙️
GPU Monitor	nvtop
System Fetch	fastfetch ⚙️
Git Fetch	onefetch
Keybindings TUI	keyb ⚙️

🖱️ GUI Apps

📚 Entry	✨ App
Music Player	Spotify (patched with Spicetify) ⚙️
Fallback Text Editor	VSCodium ⚙️
Web Browser	💖 Floorp ⚙️
Messaging App	Vesktop (Custom Discord Client) ⚙️
Email Client	Thunderbird
PDF Viewer	Zathura ⚙️
Note Taking App	💖 Obsidian ⚙️
Video Player	MPV ⚙️
Image Viewer	qimgv ⚙️
File Manager	Nemo
Audio Effects	Easyeffects ⚙️
Image Editor	Krita
VM Manager	Virt-Manager (QEMU)
Recording Program	OBS ⚙️
Office Apps	LibreOffice

🔍 Other

📚 Entry	✨ App
Colorscheme	💖 Catppuccin Macchiato
Font	JetBrainsMono Nerd Font
Icon Theme	Catppuccin-SE
Dotfiles Manager	💖 yadm ⚙️
Automatic System Deployment	💖 Ansible ⚙️

🔧 ‎ Setup

Warning

The installation guide is under construction, try it at your own risk!

It is also ment only for Arch based systems. All other distros are not supported and I will not be helping with issues related to them.

📦 Dependencies Installation

Note

The names of the packages are from the AUR and Arch Repos; adapt them to your system. Most of the packages are available on other distros official repos (most of the time out-to-date).

To install CLI/TUI specific packages in non-arch based distros, I recommend to use homebrew.

In the guide, I will be using Yay as the AUR helper. Be sure to install it or change the commands to your preferred one.

• Base Packages

First, lets start with the required base packages for the configuration to function.

yay -Sy hyprland hyprlock hypridle xdg-desktop-portal-hyprland hyprpicker \
        swww waybar waybar-updates rofi-wayland swaync swayosd-git playerctl \
        wl-clipboard wl-clip-persist cliphist udiskie devify polkit-gnome \
        pyprland qt5ct qt5-wayland qt6-wayland pavucontrol \
        fzf jq eza fd slurp grim satty vivid fish starship \
        catppuccin-gtk-theme-macchiato catppuccin-cursors-macchiato

On the first line we have the hypr ecosystem packages and on the other lines we have the must have packages.

• Optional Packages

Now lets move to the Optional Packages (If you don't want to install any more packages, move to the Dotfiles Installation step)

yay -Sy yazi nemo kitty zathura zathura-pdf-mupdf qimgv-light mpv

Here we have some packages that you can replace with your favorite ones and are not required at all for the desktop to function (though it wont look the same). For example, the terminal (kitty), the file manager (nemo and yazi), the font (ttf-jetbrainsmono-nerd), the video player (mpv), etc.

Useful CLI/TUI packages

yay -Sy ripgrep riprep-all sd duf nvtop btop dua-cli bat pacseek sysz gtrash-bin topgrade fastfetch

Useful GUI packages

yay -Sy pika-backup vesktop-bin nwg-displays nwg-look gnome-logs galculator gparted nm-connection-editor

• Icon Theme

First off, we have to download the icon package from the releases page of their repo. You can do it very easily by using curl.

curl -LJO https://github.com/ljmill/catppuccin-icons/releases/download/v0.2.0/Catppuccin-SE.tar.bz2

Once you have that, its time to extract the compressed package.

tar -xf Catppuccin-SE.tar.bz2

And finally, move them to the ~/.local/share/icons directory.

mv Catppuccin-SE ~/.local/share/icons/

• Fonts

Install the following fonts:

yay -Sy ttf-jetbrains-mono-nerd ttf-nerd-fonts-symbols ttf-nerd-fonts-symbols-mono ttf-nerd-fonts-symbols-common \
       ttf-font-awesome noto-fonts-cjk ttf-ms-win11-auto

After that, be sure to refresh the font cache:

fc-cache -fv

• Audio Service (Optional)

Note

If you have Pipewire already setup on your system, you dont have to follow this step.

Firstly, install this dependencies:

yay -S pipewire pipewire-alsa pipewire-pulse pipewire-jack wireplumber alsa-utils

Now enable pipewire and wireplumber systemd services:

systemctl --user enable --now pipewire wireplumber

And there you have it.

💾 Dotfiles Installation

Warning

Here we can take two routes. CHOOSE ONE, NOT BOTH!

• Yadm Method (recommended)

Yadm is amazing. It lets you manage your dotfiles with git without the hassle of creating a git repo on your home directory as well as gitignoring a lot of files.

It also lets you pull from the repos that you set up on remote to your local repo and then push to your personal remote.

I'd recommend you to look at it if you want a more personal and advanced config.

For now, we are going to install it the simple way without to many complications and just to have an origin to pull and another to push.

Firstly, be sure to backup your existing config files. Then, we are going to install yadm. You can do it using pacman with the following command:

sudo pacman -S yadm

After that, its time to clone the dotfiles repo into your system using yadm.

Note

If any file in your local machine differs from the one in the remote repository, your local file will remain unmodified. You'll need to manually review and resolve any differences.

yadm clone https://github.com/Matt-FTW/dotfiles.git

Congratulations, at this point your done installing the configuration! 🎉

Logout from your current desktop session and log back into the Hyprland session.

If you want to pull from my remote, commit or add any files you can do it using yadm and then the git command you want to use (pull, commit, add, etc).

Now, if you want to add your personal remote, use the following command:

yadm remote add origin <url>

Then, be sure to push your changes to your remote!

Now you can receive new updates from my repo and modify your custom one 😎

If you had any issues feel free to open an issue. Do you have some questions about the installation process? You can create a new discussion post then. Be sure to read the FAQ first!

• Git Method

Firstly, clone this repository (remember to have git installed).

git clone https://github.com/Matt-FTW/dotfiles.git
cd dotfiles

Now is time to copy the files into their respective directories. Be sure to backup your existing configuration files before copying the files. Once you have that, its time to copy the config files.

cp -r .config/* ~/.config/
cp -r .local/bin/* ~/.local/bin/

Congratulations, at this point your done installing the configuration! 🎉

Logout from your current desktop session and log back into the Hyprland session.

If you had any issues feel free to open an issue. Do you have some questions about the installation process? You can create a new discussion post then. Be sure to read the FAQ first!

➕ Post Installation

Here are some things you might consider changing or adding:

• Change Outputs

Firstly, change the outputs defined in this file. They are the ones defined for Hyprland to use, so is very important that you change them. If you wanna know what ID does your monitor has, execute hyprctl monitors.

You also need to change the workspaces associated with that monitor. For that, check this file.

For more information about Hyprland monitors and workspaces, check the docs.

Now, for the Waybar to appear you also need to change the output definition on this file.

• Change Default Applications

To change the default applications by filetype, be sure to install this app.

yay -Sy selectdefaultapplication-fork-git

If you wanna change the default apps used in the Hyprland bindings, change the variables over on this file.

• Git Changes

If you are going to use git, be sure to change the user definition as well as the credentials over on the gitconfig file.

• Laptop Additions

  • Bluetooth

    Lets start by installing bluez (bluetooth support) and overskride (GUI):

    yay -Sy bluez overskride
    

    After installing the required packages, we have to start the Bluetooth service. With systemd is pretty straightforward:

    systemctl --user enable --now bluetooth.service
    

    Now launch overskride and there you have it.

  • Brightness

    Brightness control is integrated with SwayOSD. It was installed in the first steps, so you should be able to change it. If not, be sure to read this part on the SwayOSD documentation.

    If you wanna have automatic screen brightness, install wluma.

    yay -Sy wluma
    

    Then, enable the systemd unit.

    systemctl --user enable --now wluma.service
    

  • Wi-Fi

    To manage your Wi-Fi connections, I'd recommend you to install iwgtk:

    yay -Sy iwgtk
    

    After that, enable the systemd unit just like with wluma.

    systemctl --user enable --now iwgtk.service
    

    To manage all the other network configurations, use nm-connection-editor

• Specific Configs/Information (Optional)

Finally, if you want to take a look at some specific app configuration, check the READMEs from each app in their respective config folders.

Some configuration examples are:

• fish
• neovim
• browser
• yazi
• hyprland
• vscodium
• tmux

📷 ‎ Gallery

Note

For specific images and videos about each tool, check out their own READMEs at their respective config folders. (STILL WIP 🚧)

If you want to check the wallpapers, they are available right here.

System Fetch, Pacman Colorscript, App Launcher and Notif. Center

Text Editor

TUI File Manager, ls replacement and System Fetch

GUI Text Editor

System Fetch, Matrix Script and Browser on r/unixporn

Browser with Main Page

Lockscreen

TUI System Monitor, Doom and Clock Script, ls replacement and Notif. Center

Text Editor and Audio Visualizer

File Manager, pipes script and Note Taking App

Text Editor and Git UI Manager

Audio Visualizer, Fuzzy Finder in a Git Directory and Image Viewer

Text Editor

Game Platform and Music Player

Text Editor

Old Browser with Main Page

🎉 ‎ Credits

Big thanks to everyone at r/unixporn for inspiring me to make this!

I wanna point out some resources that helped me the most with the setup:

• ArchWiki for all the awesome documentation and for helping me to not lose my mind.
• Folke for his amazing contributions to the Neovim community with some awesome plugins and with the distro that i use: LazyVim. Also, his READMEs and dotfiles are amazing!
• Yoru's README to help me with the distribution of the README.
• Amadeus Dots for helping me with the startup setup of the Hyprland WM.
• Hyprdots for helping me to take ideas from their work. Also, their setup is the best one I've ever seen for Hyprland; it's pretty awesome!.
• Catppuccin for making the Best Colorscheme Ever 🖌️
• Github-issue-templates for the some of the markdown templates of the repo.
• Shina-Fox for the incredible userChrome.
• Catppuccin-Startpage an asthetic and clean startpage for the browser.

Those were the biggest inspiring factor for me, though you can find a lot more of setups that helped me in my list of favorite dotfiles from the Stars section of my Github Profile: Check it out!

✍️ Contributing

Part of what makes the open source community special are the contributions. Any contributions will be highly appreciated!

If you have any ideas or suggestions to make, feel free to open an issue or submit a PR

Please, before submitting a PR or opening an issue, be sure to follow the contributing guidelines, as well as the issues and pull requests formatting rules.

Blank or repeated issues and PRs will be closed.

💵 Donating

If you want to support my work, please consider donating.

This is optional, but it's always appreciated.

Thank you! 💖

💕 Star History and Contributors

Thanks to everyone who have contributed and given an star to this project!

✏️ Contributors

⭐ Star History