yoru: A Lua repository from ner0z

Hi there! Thanks for dropping by! ❤️‍🔥

Yoru (夜) Aesthetic and Beautiful Awesome Environment

Welcome to my AwesomeWM configuration files!

This is my personal collection of configuration files.

You might be here looking for my AwesomeWM configuration files or looking for Linux Rice reference?

Feel free to steal anything from here but don't forget to give me credits :)

AwesomeWM is the most powerful and highly configurable next-generation framework window manager for X. Although it takes time and effort to configure it, I am very satisfied with this aesthetic result.

❄️ ‎ `Information`

Here are some details about my setup:

OS: Arch Linux
WM: awesome
Terminal: wezterm
Shell: zsh
Editor: neovim / vscode
Compositor: picom
Application Launcher: rofi
Music Player ncmpcpp

AwesomeWM Modules:

bling
- Adds new layouts, modules, and widgets that try to focus on window management primarily
color
- Clean and efficient api for color conversion in lua
layout-machi
- Manual layout for Awesome with an interactive editor
UPower
- A UPowerGlib based battery widget for the Awesome WM

Main Features:

Eye-catching Colorscheme
MacOS like window decorations
Dashboard Panel
Info Center Panel
Notification Center Panel
Bottom Panel
Word Clock Lockscreen
Minimalist Exit Screen
Music Player
App Launcher
Github Activity Previews
Brightness / Volume OSDs
LayoutList PopUP
Battery Indicator
Wifi Indicator
Calendar Widget
Weather Widget
Quick Settings Widget
Hardware Monitor Widget
Animated Workspace Indicator
Beautiful Naughty Notification
Right-Click Main Menu

This repo has a wiki! You can check it by clicking ~~here~~ here.

🔧 ‎ `Setup`

This is step-by-step how to install yoru on your system. Just R.T.F.M.

1. Install Required Dependencies and Enable Services

⚠️ ‎ This setup instructions only provided for Arch Linux (and other Arch-based distributions)

Assuming your AUR Helper is paru.

First of all you should install the git version of AwesomeWM.

paru -S awesome-git

Install necessary dependencies

paru -Sy picom-git wezterm rofi acpi acpid acpi_call upower lxappearance-gtk3 \
jq inotify-tools polkit-gnome xdotool xclip gpick ffmpeg blueman redshift \
pipewire pipewire-alsa pipewire-pulse alsa-utils brightnessctl feh maim \
mpv mpd mpc mpdris2 python-mutagen ncmpcpp playerctl --needed

Enable Services

systemctl --user enable mpd.service
systemctl --user start mpd.service

2. Install Yoru

Clone this repository

git clone --depth 1 --recurse-submodules https://github.com/rxyhn/yoru.git
cd yoru && git submodule update --remote --merge

Copy config files

cp -r config/* ~/.config/

Install a few fonts (mainly icon fonts) in order for text and icons to be rendered properly.

Necessary fonts:

Roboto - here
Material Design Icons - here
Icomoon - here

Optional fonts:

My custom Iosevka build(Aesthetic Iosevka) - here
Azuki Font - here

Once you download them and unpack them, place them into ~/.fonts or ~/.local/share/fonts.

Or you can find the required fonts inside the misc/fonts folder of this repository.

cp -r misc/fonts/* ~/.fonts/
# or to ~/.local/share/fonts
cp -r misc/fonts/* ~/.local/share/fonts/

And run this command for your system to detect the newly installed fonts.

fc-cache -fv

Finally, now you can login with AwesomeWM

Congratulations, at this point you have installed yoru! 🎉

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

🎨 ‎ `Colorscheme`

Introducing the Yoru (夜) colorscheme!

Yoru means night in english. So this beautiful and elegant color schemes are perfect for programmers who live in the middle of the night.

The nearest color combination that it can keep the eyes from getting tired! So you can keep writing code and continue all your work all night!

This colorscheme is used for all aspects in these environment, yeeaaaah this aesthetic configuration is combined with an aesthetic colorscheme <3

This colorscheme was made by me rxyhn

Xresources

! special
*.foreground:   #edeff0
*.background:   #0c0e0f

! black
*.color0:       #232526
*.color8:       #2c2e2f

! red
*.color1:       #df5b61
*.color9:       #e8646a

! green
*.color2:       #78b892
*.color10:      #81c19b

! yellow
*.color3:       #de8f78
*.color11:      #e79881

! blue
*.color4:       #6791c9
*.color12:      #709ad2

! magenta
*.color5:       #bc83e3
*.color13:      #c58cec

! cyan
*.color6:       #67afc1
*.color14:      #70b8ca

! white
*color7:        #e4e6e7
*color15:       #f2f4f5

Base46

base_30 = {
	white = "#edeff0",
	darker_black = "#060809",
	black = "#0c0e0f",
	lighter_black = "#121415",
	one_bg = "#161819",
	one_bg2 = "#1f2122",
	one_bg3 = "#27292a",
	grey = "#343637",
	grey_fg = "#3e4041",
	grey_fg2 = "#484a4b",
	light_grey = "#505253",
	red = "#DF5B61",
	baby_pink = "#EE6A70",
	pink = "#e8646a",
	line = "#1b1d1e",
	green = "#78B892",
	vibrant_green = "#81c19b",
	nord_blue = "#5A84BC",
	blue = "#6791C9",
	yellow = "#ecd28b",
	sun = "#f6dc95",
	purple = "#c58cec",
	dark_purple = "#BC83E3",
	teal = "#70b8ca",
	orange = "#E89982",
	cyan = "#67AFC1",
	statusline_bg = "#101213",
	lightbg = "#1d1f20",
	pmenu_bg = "#78B892",
	folder_bg = "#6791C9",
}

base_16 = {
	base00 = "#0c0e0f",
	base01 = "#121415",
	base02 = "#161819",
	base03 = "#1f2122",
	base04 = "#27292a",
	base05 = "#edeff0",
	base06 = "#e4e6e7",
	base07 = "#f2f4f5",
	base08 = "#f26e74",
	base09 = "#ecd28b",
	base0A = "#e79881",
	base0B = "#82c29c",
	base0C = "#6791C9",
	base0D = "#709ad2",
	base0E = "#c58cec",
	base0F = "#e8646a",
}

📑 ‎ `Fonts`

I have created a Custom Font that based on Iosevka Custom Build, has two variants Original and Nerd Font. This font supports ligatures!

This is My Favorite Monospace Font! This font is used in my terminal emulator and all my code editor. Yes, for better Code.

You know what? This Font is absolutely Awesome! If combined with Yoru Colorscheme!

Font Preview:

Regular
Italic

Installation:

Clone or Download this repository
Change the current directory to yoru/misc/fonts/Aesthetic Iosevka
Choose the variant you want, or choose both
Take actions depending on your OS:
- Windows: Select the font files and drag into font settings / font control panel page.
  - On Windows 10 1809 or newer, the default font installation is per-user, and it may cause compatibility issues for some applications, mostly written in Java. To cope with this, right click and select “Install for all users” instead. Ref.
- macOS: Follow instructions here.
- Linux : Copy the font files to your fonts directory then run sudo fc-cache.

Usage:

Original:

"editor.fontFamily": "Aesthetic Iosevka Original",
"editor.fontLigatures": true,

Nerd Font:

"editor.fontFamily": "AestheticIosevka Nerd Font",
"editor.fontLigatures": true,

🌊 ‎ `Gallery`

Modern Top Panel

Aesthetic Dashboard

Simple & Good looking Info Center

Beautiful Notification Center

Naughty Notifications

Custom mouse-friendly ncmpcpp UI

Lockscreen with PAM Integration

Minimalist Exitscreen

🗾 ‎ `History`

Ngl is started when I am felt bored lol and decided to start using Linux, more precisely in January 2022. When it's in Linuxer Desktop Art I saw a Linux setup that caught my eye, then I'm interested in and trying something similar, So yeaaaaaah this is my current setup, I made this with all Aesthetic I have. Yes! You are right! Everything you see here is all about beautiful and aesthetic, and ofc apart from targeting the beautiful UI I also pay attention to the functionality, because I'm targeting an OS that's comfortable to wear and look at. Have a Nice Day! <3

I wanna say thank you to those of you who like and love yoru. <3

📜 ‎ `License`

Yoru is under GNU GPL-3.0 License.

👤 ‎ `Author`

Yoru is created by Rxyhn.

💸 ‎ `TIP JAR`

If you enjoyed it and would like to show your appreciation, you may want to tip me here.

It is never required but always appreciated.

Thanks from the bottom of my heart! ‎ 💗

💡 ‎ `Acknowledgements`

Contributors

ner0z/yoru

Hi there! Thanks for dropping by! ❤️‍🔥

❄️ ‎ Information

🔧 ‎ Setup

🎨 ‎ Colorscheme

📑 ‎ Fonts

🌊 ‎ Gallery

🗾 ‎ History

📜 ‎ License

👤 ‎ Author

💸 ‎ TIP JAR

💡 ‎ Acknowledgements