This configuration has initially been inspired by Awesome WM Copycats. The used awesome-ayu theme uses the gorgeous ayu color palette.

• Installation
  • Dependencies
  • Quick installation example
• Configuration
• License

Installation

Dependencies

• awesome v4.3
• vicious
• owfont - symbol font for Open Weather Map API
• Font Awesome 4
• mononoki

optional to switch colorschemes

• wpgtk

Quick installation example

1. Backup your current awesome configuration

   mv $HOME/.config/awesome $HOME/.config/awesome_$(date -I)

2. Clone my configuration to ~/.config/awesome/

   git clone --recursive https://github.com/MArpogaus/awesome-rc.git $HOME/.config/awesome 

3. Install Font Awesome 4 and mononoki

   # Debian / Ubuntu
   apt install fonts-font-awesome fonts-mononoki
   # Manjaro
   pamac build ttf-font-awesome-4 ttf-mononoki

4. Download and install owfont

   wget -O /usr/share/fonts/TTF/owfont-regular.ttf 'https://github.com/websygen/owfont/blob/master/fonts/owfont-regular.ttf?raw=true'

5. Create your configuration file.

   cd $HOME/.config/awesome 
   cp config.lua.tmpl config.lua

6. Optional: install wpgtk to switch colorschemes. Details can be found in the README of awesome-ayu.

Configuration

The configuration file config.lua is used to set default applications, modkeys and adjust the appearance of the theme to your needs. The following table gives an overview of all configuration parameters required by rc.lua:

Name	Description	Type
browser	command to run the web browser	string
filemanager	command to run the file manger	string
gui_editor	command to run the gui editor	string
terminal	command to run the terminal emulator	string
lock_command	command to lock the current session	string
modkey	the mod key to use for key bindings	string
altkey	the alt key to use for key bindings	string
theme	theme to load (only ayu supposrted so far)	string

The following defaults are used as a fallback for any missing value:

{
    -- This is used later as the default terminal, editor etc.
    browser = 'exo-open --launch WebBrowser' or 'firefox',
    filemanager = 'exo-open --launch FileManager' or 'thunar',
    gui_editor = 'subl',
    terminal = os.getenv('TERMINAL') or 'lxterminal',
    lock_command = 'light-locker-command -l',

    -- Default modkey.
    modkey = 'Mod4',
    altkey = 'Mod1',

    -- Select theme
    theme = 'ayu'

}

Additionally the used awesome-ayu theme has the following configuration parameters:

Name	Description	Type
tyrannical	using Tyrannical tag managment engine	bool
xresources	load colorschemes from xresources	bool
color_scheme	colorscheme to use	string
dpi	number of pixels per inch of the screen	string
icon_theme	icon theme to use	string
wallpaper	path to your wallpaper	string
desktop_widgets	enable/disable desktop widget	bool
wibar_widgets	widgets for the wibar	array of strings
arc_widgets	widgets for the the desktop pop up	array of strings
widgets_arg	widget parameters (see below)	table

Please refer to the README of awesome-ayu for details.

License

licensed under MIT License Copyright (c) 2020 Marcel Arpogaus. See LICENSE for further details.