jasek5 / kwesomede

A desktop environment made in AwesomeWM

🎀 KwesomeDE 🎀

Thanks for dropping by!

Welcome to my AwesomeWM configuration files, aka KwesomeDE.

The setup section will guide you through the installation process. AwesomeWM is the most powerful and highly configurable, next generation framework window manager for X, Although it takes time and effort to configure it, but I'm very satisfied with the result.

❄️ ‎ Information

Here are some details about my setup:

• OS: Arch Linux
• WM: awesome
• Terminal: kitty
• Shell: zsh
• Editor: vscode
• Compositor: picom-dccsillag
• Music Player ncmpcpp

Main Features:

• Wi-Fi Applet
• Bluetooth Applet
• Audio Applet
• CPU Applet
• RAM Applet
• Disk Applet
• Introduction/Setup tool
• Screenshot tool
• Recorder tool
• Theme Manager
• Desktop Icons
• Control Panel
• Message Panel
• Info Panel
• Main Menu
• Client Menu
• App Launcher
• Lock Screen
• Power/Exit Screen
• Window Switcher
• Notifications for various system events
• Titlebars
• Ncmpcpp Custom UI
• Many more!

AwesomeWM Modules:

• bling
  • Adds new layouts, modules, and widgets that try to primarily focus on window management
• layout-machi
  • Manual layout for Awesome with an interactive editor
• color
  • Contains a bunch of useful function for conversion as well as well as a very nice api for just colors in general.

🔧 ‎ Setup

1. Install AwesomeWM

Install the git version of AwesomeWM built with LUA 5.3

Arch users can use the following PKGBUILD (makepkg -si)

_pkgname=awesome
pkgname=${_pkgname}-git
pkgver=4.3.1360.gc539e0e43
pkgrel=1
pkgdesc='Highly configurable framework window manager'
arch=('i686' 'x86_64')
url='http://awesome.naquadah.org/'
license=('GPL2')
depends=('cairo' 'dbus' 'gdk-pixbuf2' 'libxdg-basedir' 'libxkbcommon-x11'
         'lua53' 'lua53-lgi' 'pango' 'startup-notification' 'xcb-util-cursor'
         'xcb-util-keysyms' 'xcb-util-wm' 'xcb-util-xrm' 'libxfixes')
makedepends=('asciidoctor' 'cmake' 'docbook-xsl' 'git' 'imagemagick' 'ldoc'
             'xmlto')
optdepends=('rlwrap: readline support for awesome-client'
            'dex: autostart your desktop files'
            'xcb-util-errors: for pretty-printing of X11 errors'
            'librsvg: for displaying SVG files without scaling artifacts'
)
provides=('notification-daemon' 'awesome')
conflicts=('awesome')
backup=('etc/xdg/awesome/rc.lua')
source=("$pkgname::git+https://github.com/awesomeWM/awesome.git")
md5sums=('SKIP')
_LUA_VER=5.3

pkgver() {
  cd $pkgname
  git describe | sed 's/^v//;s/-/./g'
}

build() {
  mkdir -p build
  cd build
  cmake ../$pkgname \
    -DCMAKE_BUILD_TYPE=RELEASE \
    -DCMAKE_INSTALL_PREFIX=/usr \
    -DSYSCONFDIR=/etc \
    -DLUA_INCLUDE_DIR=/usr/include/lua${_LUA_VER} \
    -DLUA_LIBRARY=/usr/lib/liblua.so.${_LUA_VER} \
    -DLUA_EXECUTABLE=/usr/bin/lua${_LUA_VER}
  make
}

package() {
  cd build
  make DESTDIR="$pkgdir" install

  install -Dm644 "$srcdir"/$pkgname/awesome.desktop \
    "$pkgdir/usr/share/xsessions/awesome.desktop"
}

For other distros, build instructions are here.

2. Install Dependencies

Dependency	Why/Where is it needed?
networkmanager	Network notifcations, applet/wibar widget
blueman	Bluetooth notifcations, applet/wibar widget
pactl	Audio notifcations, applet/wibar widget
pipewire+pipewire-pulse/pulsaudio	Used by pactl
lm_sensors	CPU Temperature
inotify-tools	Daemons that monitor filesystem events
redshift	Blue light toggle
maim	Screenshot widget
flameshot	Screenshot widget
ffmpeg	Record widget
xdotool	Menu commands use this to input text into terminal
xclip	Copy screenshot into clipboard/paste text into prompt
farge	Color picker keybind
upower	Battery notifications/widgets
picom	Compositor widget/notifcations
brightnessctl	Brightness daemon and widget
playerctl	Media daemon and controls
fortune-mod	Fortune daemon (right now that daemon is unused)
xfce4-settings	Used in the main menu
imagemagick	Used to generate colors from wallpapers
yad	Used to pick a folder

Arch Linux (and other Arch-based distributions)

   pacman -Sy kitty networkmanager blueman pipewire pipewire-pulse lm_sensors inotify-tools
   redshift maim ffmpeg xdotool xclip upower brightnessctl playerctl fortune-mod flameshot
   xfce4-settings imagemagick yad --needed

Assuming your AUR Helper is yay or paru.

   yay/paru -Sy picom-animations-git farge-git --needed

3. Install Fonts

• Font Awesome 6 Pro - PAID
• Nerd Font Mono - here
• Iosevka - here
• Oswald - 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 KwesomeDE

> Clone this repository

git clone https://github.com/Kasper24/KwesomeDE --recurse-submodules

Copy config and binaries files

cp -r KwesomeDE/* ~/.config/awesome

Finally, now you can login with AwesomeWM

Congratulations, at this point you have installed this aesthetic dotfiles! 🎉

Log out from your current desktop session and log in into AwesomeWM

🌊 ‎ Gallery

Action Panel

Message Panel

Info Panel

Wi-Fi Applet

Bluetooth Applet

Audio Applet

CPU Applet

Theme Manager

Screenshot Tool

Recorder Tool

Power Screen

Lock Screen

Main Menu

Client Menu

Notification

ncmpcpp

💡 ‎ Acknowledgements

• Special thanks to
  • rxyhn
  • awesome-widgets
  • JavaCafe01
  • andOrlando
  • actionless
  • Aire-One
  • elenapan
  • manilarome
  • Mofiqul