Tsukiyomi

An elegant AwesomeWM configuration focused on beauty. Comes with a carefully crafted UI, three colorschemes, and a couple of variables to tweak the interface to the user's likings. A WIP currently. You can see this repo as a hybrid between dotfiles and an AWM configuration, but it should be modular enough to only pick what you really plan to use.

WARNING: This configuration was not tested on other machines or OS's outside of mine, my code is also not perfect, since this is my first real attempt at AWM, the code may or may not work on your end, some things here need manual tweaking and errors may occur, procceed at your own caution, you've been warned.

Dependencies

Awesome-related, obligatory

awesome-git
rubato (animations library)
bling (scratchpads and launcher)

WARNING 2: As of November 6 2023 you need to manually build awesome from source with this patch for this configuration to work, this is because of a small screen signal for properly setting wallpapers, everything else can be used as is

Music related, optional

mpd
playerctl
mpDris2
ncmpcpp
clematis

Misc Software

picom (optional)
bluez (optional)
maim, xclip, slop (obligatory)
IBM Plex Sans (optional) and/or any Nerd Font
Pipewire and Wireplumber (obligatory)
nemo (optional)

Your suite of apps can be swapped out with relative ease, but if you want to use exactly what i have, siduck's build of st, my custom neovim configuration and firefox.

Features

Tsukiyomi has a powerful user configuration in which you can tweak things like:

Colorscheme
Suite of apps
Font and icon theme
UI elements (gaps, spacing, borders)
Toggleable UI elements and signals
Accent color
Layouts and tags
Wallpaper, avatar, home icon
Dock widget
Vertical bar
Titlebars
Modkeys

And other aspects can also be tweaked outside of user configuration, like keybinds and scratchpads.

File structure

assets: images and svgs
base: keybinds, autostart, scratchpad config
modules: external libraries
signals: for awm signals
theme: theme variables and colorschemes
widget: bar, launcher, notifications, titlebar config and others
helpers.lua: helper functions
user.lua: user configuration
rc.lua: file that loads everything

Keybinds

Super + Return opens a terminal.
Super + / shows the keybinds.

TODO

Control center widget
Better keybinds popup
Overall cleanup of code

Gallery

Colorschemes

Credits

Stardust kyun's Sakura dotfiles and support, since they gave me the courage needed to tackle this project and also some sweet reference for how to do things, also the nice colorscheme
Gwynsav's gwdawful and gwileful rices, from which I borrowed some code, widgets and insight on how to execute ideas
Chadcat's Crystal rice, for the battery and dock widgets
Ner0z's dotfiles for the music widget
Garado's script for changing nvim themes
The Unixporn discord server for a lot of insight and troubleshooting
Nyoom for the oxocarbon colorscheme
Sinomor's dotfiles for some helper functions and the execution of inner and outer gaps
My mom, she's very cool

deceptionfalls / tsukiyomi