Sweet B & A for Awesome WM

Welcome

What is the purpose of Sweet B & A?

This is primarily a fork of Rxyhn's repository for the purpose of making the rc.lua file more streamlined. Relocating what were magic numbers and putting them into a centralized variable. This also adds some creature comforts like being able to switch the time across the entire theme from standard to imperial, or adding a desktop wallpaper.

I will have some goals for the end of this project, those will be listed further down. Everything here is very much a work in progress, and hasn't been tested extensively. It would seem that some things that work for Arch do not work for Manjaro, so I would not be surprised if the inverse is also true.

I'll also attempt to manually pull from upstream, but if it ends up breaking things too often, I may just decide to fully deviate the fork.

Here are some details about my setup:

Programs	Using
WM	awesome
OS	Manjaro
Terminal	alacritty / xfce4
Shell	zsh
Editor	neovim / notepadqq
Compositor	picom
Launcher	rofi

⚠ WARNING ⚠
THESE DOTFILES ARE CONFIGURED FOR 3840x2160 WITH 172 DPI.

S E T U P

This is step-by-step how to install these dotfiles. Just R.T.F.M.

This setup only provided for Arch Linux (and all Arch-based distributions)

1. Install the git version of AwesomeWM.

   paru -S awesome-git

2. Install dependencies and enable services

   • Dependencies

     paru -Sy picom-git alacritty rofi todo-bin acpi acpid acpi_call \
     wireless_tools jq inotify-tools polkit-gnome xdotool xclip maim \
     brightnessctl alsa-utils alsa-tools pulseaudio lm_sensors gpick \
     mpd mpc mpdris2 ncmpcpp playerctl redshift ffmpeg bluez-utils --needed

   • Services

     # 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

3. Install needed fonts

   You will need to install a few fonts (mainly icon fonts) in order for text and icons to be rendered properly.

   Necessary fonts:

   • Iosevka - here
   • Icomoon - here
   • Material Design - here

   Once you download them and unpack them, place them into ~/.fonts or ~/.local/share/fonts and run this command for your system to detect the newly installed fonts.

   fc-cache -v

4. Install my AwesomeWM configuration files

   Clone this repository

   git clone https://github.com/MasterMathew/Sweet-B-and-A.git
   cd Sweet-B-and-A

   Copy config and binaries files

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

   You have to add TODO_PATH in your env variable

   export TODO_PATH="path/to/todo"

5. Configure stuff

   The relevant files are inside your ~/.config/awesome directory.

   • User preferences and default applications

     In rc.lua there is a Default Applications section where user preferences and default applications are defined. You should change those to your liking.

     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 openweathermap_key and openweathermap_city_id accordingly.

6. Lastly, log out from your current desktop session and log in into AwesomeWM.

F E A T U R E S

These are the features included in Sweet-B-and-A for AwesomeWM!

• Have two themes!
  • Beautiful Day

    created by rxyhn, comfortable light colorscheme!

    
  • Aesthetic Night

    created by ner0z, extremely aesthetic dark colorscheme!

    
• Aesthetic Dashboard ngl.
  • Preview

    Aesthetic dashboard with neat grid layout, it's so clean!

    
• Very useful Control Center ikr.

  • This control center has many features!

    • Exit screen
    • Volume & brightness control
    • DnD, Blue light & Airplane mode
    • Floating layout mode
    • Theme switcher
    • wifi & bluetooth toggle
    • built in screenrec and screensht widgets
    • Hardware Monitor

    Preview

    
• Custom mouse-friendly ncmpcpp UI with album art ofc.
  • Preview

    This is aesthetic

    
• Word Clock Lockscreen with PAM Integration!

  • A lockscreen word clock

    Preview

    
• Notification Center
• ToDo Reminder
• Battery Indicator
• PopUp Notifications
• Some Tooltip Widget
• Applications Launcher

  • Minimalist app launcher

    Preview

    

K E Y B I N D S

I use super AKA Windows key as my main modifier. also with alt, shift, and ctrl

Keyboard

Keybind	Action
super + enter	Spawn terminal
super + w	Spawn web browser
super + x	Spawn color picker
super + f	Spawn file manager
super + d	Launch applications launcher
super + shift + d	Toggle dashboard
super + shift + c	Toggle control center
super + shift + n	Toggle notifications center
super + q	Close client
super + ctrl + l	Toggle lock screen
super + [1-0]	View tag AKA change workspace (for you i3/bsp folks)
super + shift + [1-0]	Move focused client to tag
super + space	Select next layout
super + s	Set tiling layout
super + shift + s	Set floating layout
super + c	Center floating client
super + [arrow keys]	Change focus by direction
super + shift + f	Toggle fullscreen
super + m	Toggle maximize
super + n	Minimize
ctrl + shift + n	Restore minimized
alt + tab	Window switcher

Mouse on the desktop

Mousebind	Action
left click	Dismiss all notifications
right click	Main menu
middle click	Toggle Dashboard
scroll up/down	Cycle through tags

For more information check awesome/configuration/keys.lua

Goals

• Priority Objectives

  • Stability
  • Rework screenshots in readme file.
  • Reorganize code to remove magic numbers
  • Document rc.lua via comments

• Stretch Goals

  • GUI option that interacts with RC.LUA to change configurations and apply
  • Void Theme
  • Alternate Default Profile Pictures
  • Alternate Default "Awesome" Buttons (besides Manjaro and Arch)
  

Please check out the original source for Sweet-B-and-A at https://github.com/rxyhn/dotfiles.

Acknowledgements 💡

• Credits

  • ner0z
  • rxyhn

• Special thanks to

  • JavaCafe01
  • ChocolateBread799
  • Elena