🎀 Elena's configuration files 🎀
This is my personal collection of configuration files.
You are probably here for my AwesomeWM configuration.
The setup section will guide you through the installation process.
Here are some details about my setup:
Here are the instructions you should follow to replicate my AwesomeWM setup.
Install the git version of AwesomeWM.
Arch users can use the awesome-git AUR package.
yay -S awesome-git
For other distros, build instructions are here.
Install dependencies and enable services
If you are curious, click here to see a table of dependencies and why they are needed.
Ubuntu 18.04 or newer (and all Ubuntu-based distributions)
sudo apt install rofi lm-sensors acpid jq fortune-mod redshift mpd mpc maim feh pulseaudio inotify-tools xdotool # Install light, which is not in the official Ubuntu repositories wget https://github.com/haikarainen/light/releases/download/v1.2/light_1.2_amd64.deb sudo dpkg -i light_1.2_amd64.deb
Arch Linux (and all Arch-based distributions)
Assuming your AUR helper is
yay -S rofi lm_sensors acpid jq fortune-mod redshift mpd mpc maim feh light-git pulseaudio inotify-tools xdotool
# For automatically launching mpd on login systemctl --user enable mpd.service systemctl --user start mpd.service # For charger plug/unplug events (if you have a battery) sudo systemctl enable acpid.service sudo systemctl start acpid.service
Install needed fonts
You will need to install a few fonts (mainly icon fonts) in order for text and icons to be rendered properly.
Once you download them and unpack them, place them into
.ttf) are deep inside multiple directories. They will be detected as long as they can be accessed from
You can find the fonts required inside the
misc/fonts folder of the repository.
cp -r ./misc/fonts/* ~/.fonts/ # Or to ~/.local/share/fonts cp -r ./misc/fonts/* ~/.local/share/fonts/
Finally, run the following in order for your system to detect the newly installed fonts.
Install my AwesomeWM configuration files
git clone https://github.com/elenapan/dotfiles cd dotfiles [ -e ~/.config/awesome ] && mv ~/.config/awesome ~/.config/awesome-backup-"$(date +%Y.%m.%d-%H.%M.%S)" # Backup current configuration cp -r config/awesome ~/.config/awesome
The relevant files are inside your
User preferences and default applications
rc.lua there is a User variables and preferences section where user preferences and default applications are defined.
You should change those to your liking. Probably the most important change you can make is to set your
For more sophisticated control over your apps, check out
Note: For the weather widgets to work, you will also need to create an account on openweathermap, get your key, look for your city ID, and set
Have a general idea of what my keybinds do
My keybinds will most probably not suit you completely, but on your first login you might need to know how to navigate the desktop.
See the keybinds section for more details.
You can edit
keys.lua to configure your keybinds.
(Optional) This is also a good time to take a look at how my configuration is structured in order to understand the purpose of each file.
Login with AwesomeWM 🎉
Congratulations, at this point you should be ready to log out of your current desktop and into AwesomeWM.
Your login screen should have a button that lets you change between available desktop sessions. If not, click here to find out how to fix it.
Try it, play with it, enjoy it. Consider checking out the Advanced setup in order to enable and configure various components that are not needed to use the desktop, but provide a better experience.
Set the wallpaper
feh --bg-fill /path/to/your/wallpaper
Load a colorscheme
xrdb -merge /path/to/colorscheme
xrdb. This also means that they play nice with tools like pywal.
After setting up my AwesomeWM configuration, inside
~/.config/awesome you will find the following:
The main configuration file which binds everything together.
This file allows you to set user preferences, choose themes, configure default layouts for each tag, window rules and more. It is also responsible for initializing all necessary desktop components.
It initializes global and client keybinds. In addition, it defines what mouse clicks do on windows, window titlebars or the desktop.
Provides functions for activating various applications, meaning either spawning them, focusing them or toggling them depending on whether they are currently running or not.
Provides various uncategorized helper functions to make our life easier and our code cleaner.
Here you can find a directory for each available theme.
Such a directory should include at least a
theme.lua and optionally icons, wallpaper, and whatever asset you need that is theme-specific.
theme.lua file usually sets colors, sizes and positions of various elements.
Here you can find a directory for each available icon theme and an
init.lua file which initializes the
Icons can be images taken from the selected icon theme or text symbols taken from some icon font.
icons.image.firefox can be used to refer to your selected theme's Firefox icon instead of using the full path to the image. This makes it easy to switch between themes.
Note: Icon themes defined here have nothing to do with your system-wide icon theme.
In this directory you can find window decoration (titlebar) styles.
They affect the layout of the titlebar and the titlebar buttons (e.g. close, maximize, minimize).
Optionally, they may implement more complex decorations, using multiple titlebars around the window to create a certain look (e.g. double borders) or achieve anti-aliased window corners.
Finally, some clients may have their own special titlebars added to them in order to simulate a custom UI.
For now, a custom
mpd UI has been implemented.
decorations module also includes helper functions that generate titlebar buttons, in case you do not have/want image buttons.
Contains desktop components or elements such as bars, sidebars, lock screens and more. Elements with multiple available themes have their own directory. For example:
elemental/bar you can find a
.lua file for each available bar or bar group.
Multiple bars can be created in one file.
Every bar theme provides the global functions
tray_toggle() which you can bind to any keys you want.
elemental/sidebar you can find a
.lua file for each available sidebar theme.
... And so on.
This directory includes notification daemons that trigger notifications for various desktop events such as volume or brightness change. Also it includes notification themes that define the layout of the notification contents.
noodle directory: Contains widgets that usually take up more than 50 lines of code.
Widgets display information in visual form (text, images, progress bars).
Without them, all desktop elements would just be empty boxes.
They are used by the desktop components defined inside the
Widgets can be defined in any file but I prefer to separate a big widget (with a lot of logic) from the element I am using it in.
Contains daemons (processes that run in the background) which emit system info.
They provide an easy way of writing widgets that rely on external information. All you need to do is subscribe to the signal a daemon provides. No need to remember which shell command gives you the necessary info or bother about killing orphan processes. Evil takes care of everything.
I use super AKA Windows key as my main modifier.
|super + enter||Spawn terminal|
|super + shift + enter||Spawn floating terminal|
|super + d||Launch rofi|
|super + shift + q||Close client|
|super + control + space||Toggle floating client|
|super + [1-0]||View tag AKA change workspace (for you i3 folks)|
|super + shift + [1-0]||Move focused client to tag|
|super + s||Tiling layout|
|super + shift + s||Floating layout|
|super + w||Maximized / Monocle layout|
|super + [arrow keys]||Change focus by direction|
|super + [hjkl]||^|
|super + shift + [arrow keys]||Move client by direction. Move to edge if it is floating.|
|super + shift + [hjkl]||^|
|super + control + [arrow keys]||Resize client|
|super + control + [hjkl]||^|
|super + f||Toggle fullscreen|
|super + m||Toggle maximize|
|super + n||Minimize|
|super + shift + n||Restore minimized|
|super + c||Center floating client|
|super + u||Jump to urgent client (or back to last tag if there is no such client)|
|super + b||Toggle bar|
|super + =||Toggle tray|
... And many many more.
||Dismiss all notifications, close sidebar and main menu|
||Jump to urgent client (or back to last tag if there is no such client)|
||Cycle through tags|
||Focus and raise|
If you enjoy my themes and would like to show your appreciation, you may tip me here.
It is never required but always appreciated.
Thank you from the bottom of my heart! 💙