/material-awesome

Material and Mouse driven config for AwesomeWM 4.3

Primary LanguageLuaMIT LicenseMIT

Material and Mouse driven theme for AwesomeWM 4.3

Original work by PapyElGringo, official development seem to have moved to material-shell

This is a fork of Chris Titus's material-awesome who forked it from HikariKnight's fork of the original project

Note: This fork focuses on adding more documentation and comments, customising it to my workflow and making it more accessible

An almost desktop environment made with AwesomeWM following the Material Design guidelines with a performant opiniated mouse/keyboard workflow to increase daily productivity and comfort.

Click to view in high quality

Tiled Panel Exit screen

Installation

Note: the best transition is from gnome to material-awesome as KDE-plasma can break some indicators until plasma is purged entierly.

1) Get all the dependencies

sudo apt install awesome fonts-roboto rofi compton i3lock xclip qt5-style-plugins materia-gtk-theme lxappearance xbacklight kde-spectacle nautilus xfce4-power-manager pnmixer network-manager-applet -y
wget -qO- https://git.io/papirus-icon-theme-install | sh

Program list

  • AwesomeWM as the window manager - universal package install: awesome
  • Roboto as the font - Debian: fonts-roboto Arch: ttf-roboto
  • Rofi for the app launcher - universal install: rofi
  • Picom (formerly Compton) for the compositor (blur and animations) universal install: picom
  • i3lock the lockscreen application Arch Install: i3lock Debian: i3lock-fancy
  • gnome-keyring and a policykit-agent (by default policykit-1-gnome is enabled) OR mate-polkit
  • Materia as GTK theme - Arch Install: materia-theme Debian: materia-gtk-theme
  • Papirus Dark as icon theme
  • lxappearance to set up the gtk and icon theme
  • (Laptop) xbacklight for adjusting brightness on laptops (disabled by default)
  • flameshot a fantastic screenshot utility. Install: flameshot
  • pnmixer Audio Tray icon that is in debian repositories and is easily installed on arch through AUR.
  • network-manager-applet nm-applet is a Network Manager Tray display from GNOME.
  • xfce4-power-manager XFCE4's power manager is excellent and a great way of dealing with sleep, monitor timeout, and other power management features.

2) Clone the configuration

git clone https://github.com/wizzdom/material-awesome.git ~/.config/awesome

3) Set the themes

Start lxappearance to active the icon theme and GTK theme Note: for cursor theme, edit ~/.icons/default/index.theme and ~/.config/gtk3-0/settings.ini, for the change to also show up in applications run as root, copy the 2 files over to their respective place in /root.

4) Same theme for Qt/KDE applications and GTK applications, and fix missing indicators

First install qt5-style-plugins (debian) | qt5-styleplugins (arch) and add this to the bottom of your /etc/environment

XDG_CURRENT_DESKTOP=Unity
QT_QPA_PLATFORMTHEME=gtk2

The first variable fixes most indicators (especially electron based ones!), the second tells Qt and KDE applications to use your gtk2 theme set through lxappearance.

5) Read the documentation

The documentation live within the source code.

The project is split in functional directories and in each of them there is a readme where you can get additional information about the them.

  • Configuration is about all the settings available
  • Layout hold the disposition of all the widgets
  • Module contain all the features available
  • Theme hold all the aesthetic aspects
  • Widget contain all the widgets available