NOTICE
These dotfiles and the instructions on how to set them up are still under construction, and testing is still being done. Proceed with caution.
Details
- Window Manager - bspwm
- Compositor - picom
- Shell - zsh
- Terminal - kitty
- Bar and Widgets - eww
- Launcher - rofi
- Notification Daemon - dunst
Setup
These setup steps use paru, but feel free to use your AUR helper of choice.
WARNING:
Be sure to back up any relevant files before continuing. Chezmoi will ask what you should do if a conflict occurs, but back up your files just in case. You can see what will be applied at a glance with chezmoi status
and chezmoi diff
.
Single Line Installation
sh -c "$(curl -fsSL https://raw.githubusercontent.com/Battlesquid/dotfiles/main/install.sh)"
Manual Installation
Install dependencies:
paru -S chezmoi xorg bspwm picom-animations-git kitty eww rofi dunst redshift pamixer xorg-xinit networkmanager noto-fonts nerd-fonts-noto-sans-mono ttf-font-awesome brightnessctl cava glava neofetch neovim sxhkd betterlockscreen flameshot feh playerctl jq recode moreutils jgmenu xcolor bluez-utils xqp xdo zsh
Fetch the dotfiles using:
chezmoi init https://github.com/Battlesquid/dotfiles.git
Confirm the changes that will be made.
chezmoi diff
Install with:
chezmoi apply -v
Logout of your session and then start with:
startx
Custom Installation
If you wish to manually move/symlink/view the dotfiles source, you can generate an archive of the source. For example:
chezmoi cd
chezmoi --source-path archive src/**/* --output=~/dotconfig.tar.gz
The archive will be in your home directory. This can be done with any folder/file in the source directory, so you can choose how to build out your archive. You can see a full list of potential archive targets with chezmoi managed
.
Miscellaneous
Weather widget
- Grab an OpenWeather API key. Also determine the city you would like to use.
- Create a
secrets
file with:
touch ~/.config/eww/fool_moon/common/scripts/secrets
- Copy the contents below into the secrets file, substituting in the API key and city.
#!/bin/sh
WEATHER_API_KEY="<YOUR_API_KEY_HERE>"
WEATHER_API_CITY="<YOUR_CITY_HERE>"
GTK theme and icons
You can acess the GTK theme I made for this rice here. I use the Papirus icon theme.
Credits
Feel free to use anything in this repo, just be sure to provide proper credit.
Some scripts/config files were borrowed/adapted from the following repos:
- adi1090x/widgets
- Syndrizzle/hotfiles
- mmsaeed509/bspwm-dots
- saimoomedits/eww-widgets
- janleigh/dotfiles
Contributing
Since these are my dotfiles, I will not review/implement changes that fundamentally change how the configuration is set up. However, if you find a problem/inconsistency that can be improved without fundamentally changing the configuration (i.e., fixing a script to handle an edge-case), feel free to open an issue or PR.