{"id":20827372,"url":"https://github.com/gokulp01/aureole","last_synced_at":"2025-05-07T21:03:58.765Z","repository":{"id":133739655,"uuid":"400952676","full_name":"gokulp01/aureole","owner":"gokulp01","description":"aureole: An awesome Awesomewm rice (also my first :) )","archived":false,"fork":false,"pushed_at":"2022-01-24T07:11:33.000Z","size":3319,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T21:03:54.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gokulp01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-29T04:47:51.000Z","updated_at":"2024-05-05T18:57:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"b39b1d02-e974-4f9d-a710-331b36ccde3c","html_url":"https://github.com/gokulp01/aureole","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokulp01%2Faureole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokulp01%2Faureole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokulp01%2Faureole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokulp01%2Faureole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gokulp01","download_url":"https://codeload.github.com/gokulp01/aureole/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252954409,"owners_count":21830902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T23:11:55.576Z","updated_at":"2025-05-07T21:03:58.756Z","avatar_url":"https://github.com/gokulp01.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aureole\nAn awesome Awesomewm rice \n\n![](screenshots/ss2.png) \n\n## Contents ##\n1. [Details](#details)\n2. [Features](#features)\n3. [Dependencies](#dependencies)\n4. [Installation](#installation)\n5. [Folder Structure](#folderStructure)\n6. [My Preferred Applications](#applications)\n7. [Keybinds](#keybinds)\n8. [Notes](#notes)\n9. [Gallery](#gallery)\n\n\u003ca name=\"details\"\u003e\u003c/a\u003e\n## Details ##\n+ **OS**: Ubuntu 18.04\n+ **Shell**: ZSH\n+ **WM**: awesome\n+ **Terminal**: Termite\n\n\u003ca name=\"features\"\u003e\u003c/a\u003e\n## Features ##\n+ Super lightweight\n+ Supports multi monitor setups!\n+ Automatic dpi / resolution scaling\n  + Note that xft.dpi must be properly assigned in the .Xresources file if you are using a high DPI screen\n+ Easy installation and configuration\n+ Minimal Dependencies\n+ Wallpaper auto-blur \n+ Exit screen\n+ Borders around active window\n+ Taglist shows only active workspace and not empty ones\n+ Lock screen (via `slock`)\n+ Very stable :) Built off awesome 4.3 release, no bleeding edge git versions required here!\n\n\u003ca name=\"dependencies\"\u003e\u003c/a\u003e\n## Dependencies ##\nAll possible efforts have been taken to limit the amount of dependencies by utilising the Awesome API (see [Installation section](#installation)). Here are the dependencies:\n\n|Dependency|Description|\n|:----------:|:-------------:|\n|`awesome`|Window manager|\n|`picom`|Window compositor|\n|`rofi`|Application launcher|\n|`slock`|Lock screen|\n|`imagemagick`|**OPTIONAL BUT NEEDED IF USING A DIFFERENT BACKGROUND**, used in config to generate blurred wallpaper|\n\n### Optional Dependencies ###\n\n|Dependency|Description|\n|:----------:|:-------------:|\n|`acpi`|Battery management cli application|\n|`xfce4-power-manager`|Power manager|\n|`blueman`|Bluetooth managing application|\n|`nm-connection-editor`| GUI wifi connection editor|\n|`alsa-utils`|Provides kernel driven sound drivers|\n\n\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## Installation ##\n1. Ensure all [dependencies](#dependencies) are met\n2. Clone this repository and place its contents as follows:\n\n   a. all the files other than the `rofi` folder goes into the `awesome` folder which is present in your `.config`\n   \n   b. place the contents of `rofi` into your `rofi` folder(generally located in `~/.config`)\n\nOr, if you are lazy, just copy paste the following :P\n```\ngit clone https://github.com/gokulp01/aureole\ncp aureole/* ~/.config/awesome\nrm -rf aureole  \ncd ~/.config/awesome\nmv rofi ../\n```\n3. optional: navigate to the `awesome/wallpaper` folder and place your desired wallpaper there, ensuring that it is named `wallpaper`. One  awesome (pun intended) feature of my config is that the filetype of the wallpaper can be any image filetype and it will automatically recognize it. Remember to delete the `blurredWallpaper` file in order to make the blurring script recognize a new wallpaper has been added and needs to be blurred \n4. optional: edit the `apps.lua` file to define your desired default and startup applications\n5. optional: edit the `keys.lua` file to change / add keybinds\n\nRestart Awesome. Generally, the keybinding is `mod4+ctrl+r`\n\n\u003ca name=\"folderStructure\"\u003e\u003c/a\u003e\n## Awesome Folder File Structure ##\nIn order to avoid a poorly organized `rc.lua` spanning thousands of lines, it has been split into multiple files / folders:\n+ `rc.lua`: Script that runs when awesome starts (essentially links all the other files together)\n+ `apps.lua`: Default and startup applications\n+ `keys.lua`: Keybinds\n+ `rules.lua`: Window rules\n+ `theme.lua`: Theme variables\n+ `tags.lua`: Tag information\n+ `icons`: Icons used in WM\n+ `components`: Components of the WM, such as panels, volume and brightness sliders, notification pop-ups, etc\n+ `widgets`: Widgets used in the functionality of the components\n+ `wallpaper`: Wallpaper and its blurred varient is generated / stored\n\n\u003ca name=\"applications\"\u003e\u003c/a\u003e\n## My Preferred Applications ##\n+ **Text Editor - LunarVim:** Really cool variant of NVim. Make sure to check it out!\n+ **File Manager - PCManFM** \n+ **Archive Manager - File-roller**: It just works :)\n+ **Web Browser - edge** \n+ **Terminal - Termite**: High time I switch ;_;\n\n\n\n\u003ca name=\"keybinds\"\u003e\u003c/a\u003e\n## Keybinds ##\n**Note that the modkey is set to be the Windows key. If you would like to use a different modkey check out the `keys.lua` file.**\n\n![](/screenshots/ss3.png) \n\n\u003ca name=\"notes\"\u003e\u003c/a\u003e\n## Notes ##\n+ [Awesome API Documentation](https://awesomewm.org/apidoc/index.html)\n+ If you encounter any problems please open an issue in this repo and I will gladly investigate it\n\n\n\u003ca name=\"gallery\"\u003e\u003c/a\u003e\n## Gallery ##\n![](/screenshots/ss1.png)\n![](/screenshots/ss2.png)\n![](/screenshots/ss4.png)\n![](/screenshots/ss5.png) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgokulp01%2Faureole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgokulp01%2Faureole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgokulp01%2Faureole/lists"}