Skip to content

foo-dogsquared/dotfiles

Repository files navigation

dotfiles

My dotfiles for my Linux-based system setup. The structure of this repo is designed to be managed with GNU Stow, a symlinks farm manager.

I don’t know what I’m doing most of the time in creating this setup so if you’re brave (or suicidal) enough to take a look at my stuff, go ahead.

Caution
As they always say: "Don’t blindly apply these dotfiles unless you know what you’re doing." Review the code first, change the setting accordingly, and apply it on your own if you want.

Tour of my setup

Here’s what the setup should look like (aside from the Stow packages which will be discussed later):

dotfiles
├── .vtsm/
├── docs/
├── LICENSE
├── makefile
├── README.adoc
└── vtsm

The big picture for my dotfiles setup have big goals and those are (according to priority):

  • Easy to transfer and/or reproduce.

  • Modularity, @holman-style.

  • Looking cool (but not too cool or else my potato will weep).

How I maintain my dotfiles

The dotfiles are mostly intended to be used with GNU Stow. If you’re not familiar with it, you can read this sweet short article to get you started.

However, with Python 3 (specifically 3.8) installed, you have another option. Behold, the "Very Tiny Stow Manager" (VTSM for short)! The best way to describe VTSM is basically GNU Stow with a generic shell runner. VTSM takes inspiration from GNU Stow (obviously) and how Zach Holman’s dotfiles are set. When managing your dotfiles, VTSM is going to be your friend/workmate.

All VTSM needs is a directory containing a package list stored in a JSON file with the name of the packages and their target path. By default, it searches for a file named locations.json but you can specify what JSON file to use with the -m/--manifest option.

An example of what a manifest could contain
{
    "alacritty": "$HOME/.config/alacritty/",
    "bin": "$HOME/bin/",
    "bspwm": "$HOME/.config/bspwm/",
    "dunst": "$HOME/.config/dunst/",
    "emacs": "$HOME/.config/doom",
    "lf": "$HOME/.config/lf",
    "nvim": "$HOME/.config/nvim/",
    "picom": "$HOME/.config/picom",
    "polybar": "$HOME/.config/polybar",
    "rofi": "$HOME/.config/rofi/",
    "sxiv": "$HOME/.config/sxiv",
    "sxhkd": "$HOME/.config/sxhkd/",
    "wal": "$HOME/.config/wal",
    "xorg": "$HOME",
    "zsh": "$HOME"
}

With the tiny manager and the package list, we can then execute commands with all of the packages and its target path with one go. Here are some examples of running commands with VTSM.

# Take the setup as the filesystem structure.
# See the JSON files at .vtsm to see what packages to be installed and where to install them.

# Running the program without any arguments for a test run.
# There should be a bunch of `echo` commands being ran for all of the listed packages.
./vtsm

# Create the directories of the target path and install them with GNU Stow.
# Bada-bing, bada-boom, you have installed your setup or something.
./vtsm --manifest .vtsm/arch.json --commands "mkdir -p {location} && stow {package} --target {location}"

# Run commands only to Rofi and Emacs config files.
./vtsm --manifest .vtsm/arch.json --only "rofi" "emacs" --commands "stow --restow {package} --target {location}"

For the command string, it is a Python template with package and location as the available objects.

Custom scripts

Next are more custom scripts! They’re located in bin/ and ideally should be linked in $HOME/.local/bin. [1]

Here’s a list of the top most useful scripts (at least for me):

Inspirations

Wallpapers

Here’s a list of some of the best wallpapers I’ve used throughout my ricing journey. I’ve also tried to get the creators to show appreciation for their work.

Sources

My personal recommendations for looking out for more cool-looking photos.


1. This is a part of the package list but I think it’s appropriate to create a dedicated subsection for this.