Git Product home page Git Product logo

material-awesome's Introduction

Material and Mouse driven theme for AwesomeWM 4.3-git

Original work by PapyElGringo, updated framework (and what this if forked from) by manilarome. PapyElGringo is now working on Material-Shell instead.

Note: This is my personal config, I am willing to accept pull requests that fix bugs or adds features that are missing. As this is pretty much a freetime project by someone who is not familiar with lua, do not expect this to be under super active development by me(as I know little to no lua). This is why I recommend you to fork this project and use that to store your own personal config and just use this as a base.

What is Material-Awesome?

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

Tiled Panel Exit screen Notification center

I have an issue, can I get help?

I am pretty much most likely as green as you when it comes to lua, but you can submit an issue in the issue tracker and me or someone else will attempt to help you if we know the answer.

Feel free to @HikariKnight in the issue message too to send me a mail notification!

Known bugs

  • Clicking a notification does not raise the window/application that sent it.
    This seems to be an issue with the new notification api that uses dbus in awesomewm

Installation

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

1) Get all the dependencies

  • AwesomeWM as the window manager (you will need to build awesome from source using the master branch)
  • Roboto as the font
  • Rofi for the app launcher
  • Picom for the compositor (you will have to build it from source, compton is not compatible!)
  • i3lock-fancy the lockscreen application
  • xclip for copying screenshots to clipboard
  • gnome-keyring-daemon and a policykit-agent (by default policykit-1-gnome is enabled)
  • kitty as terminal emulator
  • (Optional) qt5-styles-gtk2 or qt5-styles-plugins for making QT and KDE applications look the same as gnome applications (standalone QT applications will still show up using their default theme, this cannot be fixed!)
  • (Optional) Materia as GTK theme
  • (Optional) Papirus Dark as icon theme
  • (Optional) lxappearance to set up the gtk and icon theme
  • (Optional) xrandr to adjust laptop brightness (LVDS output)
  • (Optional) Ksnip my personal screenshot utility of choice, can be replaced by whichever you want, just remember to edit the screenshot utility script!
  • (Optional) Redshift For blue light filter

2) Add the awesomewm session file if it was not created

After installing all the dependencies (and compiled and installed awesomewm from source!)
Run the below command

ls /usr/share/xsessions

If the above command does not list an awesome.desktop file then copy the below text into /usr/share/xsessions/awesomewm.desktop

[Desktop Entry]
Name=awesome
Comment=Highly configurable framework window manager
TryExec=awesome
Exec=awesome
Type=Application
Icon=/usr/share/pixmaps/awesome.xpm
Keywords=Window manager

3) Clone the configuration

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

This theme requires the current (as of 23.02.2021) master branch of Awesome, it does not work on Awesome 4.3-stable which is what most distros ship. If you want to install the older config on Awesome4.3-stable or Awesome 4.2 use the specific awesome-4.2 or awesome4.3-stable branch (not in development by me)

Lua5.4: Lua version 5.4 changed how require works, this is a breaking change with Lua 5.3, a special Lua5.4 compatible branch has been made for the transition period

git clone -b lua5.4 https://github.com/HikariKnight/material-awesome.git ~/.config/awesome

Awesome4.3-stable (older version with less features, no longer maintained, browse the branch for install requirements!)

git clone -b awesome4.3-stable https://github.com/HikariKnight/material-awesome.git ~/.config/awesome

Awesome4.2

git clone -b awesome-4.2 https://github.com/PapyElGringo/material-awesome.git ~/.config/awesome

4) 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.

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

First install qt5-style-plugins (or qt5-style-gtk2) 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 most Qt and KDE applications (from your distributions repository) to use your gtk2 theme set through lxappearance.

6) Do your basic configuration

Open apps.lua and config.lua and make your changes.
I recommend you to make your own fork of this project!

You can search the code to find the file you are looking for using this command if you ever plan to edit the source files directly.

grep -Ri "what you are searching for" ~/.config/awesome/

7) Read the documentation

The documentation live within the source code.

The project is split in functional directories and in each of them there should be a readme where you can get additionnal informations about the contents of the folder.

  • Configuration is about all the settings available
  • Layout hold the disposition of all the widgets (panels, dashboard layout, etc)
  • Module contain all the features available
  • Theme hold all the aestetic aspects
  • Widget contain all the widgets available
  • Utilities contains all the utility scripts

material-awesome's People

Contributors

hikariknight avatar ollycat avatar papyelgringo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

material-awesome's Issues

Config broken on latest arch awesome git

Oops, an error happened! /home/icedborn/.config/awesome/layout/init.lua:28: attemp to index a nil value (field top_panel)

It happens with other values if you disable the one on 28.

Compton not running at startup

This line
'compton --config ' .. filesystem.get_configuration_dir() .. '/configuration/compton.conf',
in my ~/.config/awesome/configuration/appls.lua.txt is not able to run compton at the startup

apps.lua.txt

Weird lua error on awesome startup

Hi @HikariKnight,
First of all, sorry if this ain't the place for questions... and thx for your work, it looks awesome & I can't wait to have a up & running setup that uses it.
I've spent most of the day trying to install your theme but I can't seem to make my way around what I think is a lua error when awesomewm starts.

I've also tried to install themes from https://github.com/manilarome/the-glorious-dotfiles but a similar error shows up & awesome stays ugly :(

image

I've downloaded a debian-testing img & installed it in virtualbox, built awesome from source using the instructions at https://github.com/awesomeWM/awesome/tree/master#debian-based & then installed the dependencies.

Have I missed something along the way, like a dependency or anything that could cause such an error ?
Is there any procedure that I could follow coming from a clean no-DE environment ?

Thx in advance.

PS : the actual error that shows up says there's a probem with this line :

theme.titlebar_bg_focus = gtk_variable().bg_color:sub(1,7)-- .. '66'

which is the first line where gtk_variable() is called. That might help you understand what could be wrong...

Any way to call the exit screen by a keybinding?

Hi,
Your exit_screen looks super nice.
I am a keyboard based person so I was wondering if there is any easy way to implement calling exit_screen by keybinding.
As the exit-screen is module I am curious if its possible and easy to just include it in my own awesome setup.

I am quite new with lua and awesome so being getting load of errors without success.
I added this.

require('module.exit-screen')

I guess it could somehow map the keybinding to call

'module::exit_screen:show',

How to add a weather widget

Hi hikari,
I admire your work on this theme fro papy, but i've been facing issues with adding a weather widget from streetturtle github to the top panel but because of some changings done because of this on awesome i'm having issues, so could you help me on this one?
Regards

How to change the wallpaper in the latest Awesome 4.3

Hey Hikari,
I think you remember me from the CTT channel. I have some problems changing the wallpaper in the new updated version of the AwesomeWM. All the other forums are based on the older version of Awesome.

I use all the default script files that came out of the box.

Thanks Hikari!

Language Switcher widget

I know that AwesomeWM have Language layout widget, but customization and keybinding is weird.

Upcoming overhaul (now live in the master branch)

So as of the past half year i have been trying out PapyElGringo's material-shell and been running that along with system76's pop-shell, both of them i find lacking in one thing or the other.

So the other day i stumbled upon a fork of material-shell named floppy-desktop by manilarome, I liked a lot of the quality of life changes they had done to material-awesome while keeping things working and even updated for the upcoming awesome version.

They even added a notification center which i love, and fixed tons of bugs that were in material-awesome!

But i did not like the theme, the theme was replaced with something different.
So i am currently (with my limited to non existent lua knowledge) backporting the floppy-desktop to be more similar to the material-awesome it was forked from.

This upcoming overhaul will break support for awesome-stable (4.3 as of writing)
and will require users to compile awesome from source in order to get access to the new "ruled" library which manilarome has taken advantage of.

This means the current main branch will get archived as awesome4.3, while the new manilarome backported version will become the new main.

NOTE: all the things removed from floppy-desktop theme has been just commented out so whoever wants to use those features can re-enable them!

So far this is the progress visually
image
image
image
image
image
image

For a comparison, this is what Floppy-Desktop looked like before i started "materializing" it
image

Not all startup items working

image
I've added these custom startup items and for some reason "kitty --class=startup-kitty-3", "kitty --class=startup-kitty-4", "bash -c "kitty --class=startup-kitty-bpytop bpytop" and "bash -c "kitty --class=startup-kitty-nvtop nvtop" do not start on system boot. Running those lines in the terminal work just fine.

app list has weird text backround

So I absolutely love this awesomewm theme it really great but I am having this weird issue with the app launcher, see the image.
this is my awesome version (git) awesome v4.3-1159-geddabebac (Too long)

ksnip_20211001-081538

readme correction

replace :
git clone -b awesome-4.3-stable https://github.com/HikariKnight/material-awesome.git ~/.config/awesome
with :
git clone -b awesome4.3-stable https://github.com/HikariKnight/material-awesome.git ~/.config/awesome

Brightness slider broken?

when I use the brightness slider all the way up, it just goes back down to half, but i can move it down as much as I want. Please help me fix this!!
Thank you

Edit drawer menu color

image
I'm trying to edit the drawer menu color (blue) and I can't find the line I have to edit.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.