Skip to content

Commit

Permalink
Update: New README, fixed installation of vsc extensions (install-on-…
Browse files Browse the repository at this point in the history
…arch script and README)
  • Loading branch information
Keyitdev committed Jul 31, 2023
1 parent 1d1a7ea commit c48a005
Show file tree
Hide file tree
Showing 93 changed files with 119 additions and 29,645 deletions.
213 changes: 117 additions & 96 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,19 @@
# Keyitdev Dotfiles
# Keyitdev Dotfiles

The **Arch Linux** & **i3wm** dotfiles!
## [Watch on Youtube](https://youtu.be/tSreyGcCMB4) <img alt="" align="right" src="https://img.shields.io/github/forks/keyitdev/dotfiles?color=bf616a&labelColor=1b1b25&style=for-the-badge"/> <img alt="" align="right" src="https://img.shields.io/github/stars/keyitdev/dotfiles?color=dd864a&labelColor=1b1b25&style=for-the-badge"/>

[Showcase](#showcase) ·
[Information](#information) ·
[Installation](#installation) ·
[Cheat sheet](#cheat-sheet) ·
[Support and Thankies](#support-and-thankies)
### [Showcase](#showcase) · [Manual installation](#manual-installation) · [Detailed info](#detailed-information) · [Troubleshooting](#troubleshooting) · [Contributions](#contributions)

**i3wm** is very simple, old tiling window manager, but it is still powerful and highly configurable. Although it takes time and effort to configure it, but I'm very satisfied with the result.
The **Arch Linux** & **i3wm** dotfiles!

This is the third version of my dotfiles, as I gain more experience I am able to create more profesional dotfiles.

**However, if you want to check older version see [v2 branch](https://github.com/Keyitdev/dotfiles/tree/v2).**

![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/1.png?raw=true)

### [Watch viedo demo here](https://youtu.be/tSreyGcCMB4)

[![](https://img.shields.io/github/stars/keyitdev/dotfiles?color=dd864a&labelColor=1b1b25&style=for-the-badge)](https://github.com/Keyitdev/dotfiles/stargazers)
[![](https://img.shields.io/github/forks/keyitdev/dotfiles?color=bf616a&labelColor=1b1b25&style=for-the-badge)](https://github.com/Keyitdev/dotfiles/network/members)
[![](https://img.shields.io/github/license/keyitdev/dotfiles?color=999f63&labelColor=1b1b25&style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.html)
## Information

<img src="https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/1.png?raw=true" alt="Rice Showcase" align="right" width="400px">

- **OS:** [Arch Linux](https://archlinux.org)
- **WM:** [i3-gaps](https://github.com/Airblader/i3)
- **Terminal:** [alacritty](https://github.com/alacritty/alacritty)
Expand All @@ -32,72 +23,50 @@ This is the third version of my dotfiles, as I gain more experience I am able to
- **Application Launcher:** [rofi](https://github.com/davatorium/rofi)
- **Notification Deamon:** [dunst](https://github.com/dunst-project/dunst)

<details>
<summary><b>
Detailed information and dependencies
</b></summary>
## Automatic installation

### Info
```sh
git clone -b v3 --depth 1 https://www.github.com/keyitdev/dotfiles.git
cd dotfiles
chmod +x install-on-arch.sh
./install-on-arch.sh
```
> Warning: Remember to always read the scripts you run from the internet first.
**Music Player:** [mpd](https://github.com/MusicPlayerDaemon/MPD) & [ncmpcpp](https://github.com/ncmpcpp/ncmpcpp)
**Editor:** [neovim](https://github.com/neovim/neovim) / [vscode](https://github.com/microsoft/vscode)
**Lockscreen:** [i3lock-color](https://github.com/Raymo111/i3lock-color)
**Display Manager:** [sddm](https://github.com/sddm/sddm)
**File manager:** [ranger](https://github.com/ranger/ranger) / [nemo](https://github.com/linuxmint/nemo)
**Pdf reader:** [zathura](https://github.com/pwmt/zathura)
**Monitor of Resources:** [btop](https://github.com/aristocratos/btop)
> Note: Last time I tested the installation script on 31 July 2023, Everything worked fine.
### Used themes
## Showcase

**Shell Framework:** [Oh-My-Zsh](https://github.com/ohmyzsh/ohmyzsh)
**Vscode Theme:** [One dark pro](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme)
**Neovim Theme:** [AstroNvim](https://github.com/kabinspace/AstroVim)
**Icons:** [Papirus dark](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
**GTK Theme:** [Tokyo night](https://github.com/Fausto-Korpsvart/Tokyo-Night-GTK-Theme)
**Display Manager Theme:** [Sddm-flower-theme](https://github.com/Keyitdev/sddm-flower-theme)

### Fonts

**Icons:** [Feather](https://github.com/AT-UI/feather-font/blob/master/src/fonts/feather.ttf)
**Interface Font:** [Open sans](https://fonts.google.com/specimen/Open+Sans#standard-styles)
**Monospace Font:** [Roboto mono](https://fonts.google.com/specimen/Roboto+Mono#standard-styles)
**Polybar Font:** [Iosevka nerd font](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/Iosevka)
### neofetch

### Dependencies
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/1.png?raw=true)

**Base:** acpi alsa-utils base-devel curl git pulseaudio pulseaudio-alsa xorg xorg-xinit
### vsc & ncmpcpp & cava

**Required:** alacritty btop code dunst feh ffcast firefox i3-gaps i3lock-color i3-resurrect libnotify light mpc mpd ncmpcpp nemo neofetch neovim oh-my-zsh-git pacman-contrib papirus-icon-theme picom polybar ranger rofi scrot slop xclip zathura zathura-pdf-mupdf zsh
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/2.png?raw=true)

**Sddm:** qt5-graphicaleffects qt5-quickcontrols2 qt5-svg sddm
### rofi & dunst

**Emoji:** fonts: noto-fonts noto-fonts-cjk noto-fonts-emoji noto-fonts-extra
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/3.png?raw=true)

</details>
<details>
<summary><h3>More screenshots</h3></summary>

## Showcase
### nemo & nvim & ranger

|neofetch|vsc & ncmpcpp & cava|
|-|-|
|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/1.png?raw=true)|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/2.png?raw=true)|
|rofi & dunst|nemo & nvim & ranger|
|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/3.png?raw=true)|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/4.png?raw=true)|
|i3lock-color|sddm|
|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/5.png?raw=true)|![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/6.png?raw=true)|
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/4.png?raw=true)

## Installation
### i3lock-color

### Using install script
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/5.png?raw=true)

Clone the repository.
```sh
git clone -b v3 --depth 1 https://www.github.com/keyitdev/dotfiles.git
cd dotfiles
chmod +x install-on-arch.sh
./install-on-arch.sh
```
### sddm

### Manual Installation
![](https://github.com/Keyitdev/screenshots/blob/master/dotfiles/v3/screenshots/6.png?raw=true)

</details>

## Manual Installation

1. Clone this repository.
```sh
Expand Down Expand Up @@ -130,7 +99,7 @@ chmod +x install-on-arch.sh
sudo cp -r ./fonts/* /usr/share/fonts
sudo cp -r ./tokyonight_gtk /usr/share/themes
cp -r ./wallpapers/* "$HOME"/Pictures/wallpapers
cp -r ./vsc/* "$HOME"/.vscode-oss/extensions
code --install-extension zhuangtongfa.Material-theme
cp ./vsc/settings.json "$HOME"/.config/Code\ -\ OSS/User
sudo cp ./keyitdev.zsh-theme /usr/share/oh-my-zsh/custom/themes
cp ./.zshrc "$HOME"
Expand All @@ -144,7 +113,12 @@ chmod +x install-on-arch.sh
nvim +PackerSync
fc-cache -fv
```


7. Install sddm.
```sh
yay -S --needed qt5-graphicaleffects qt5-quickcontrols2 qt5-svg sddm
```

8. Install sddm flower theme.
```sh
sudo git clone https://github.com/keyitdev/sddm-flower-theme.git /usr/share/sddm/themes/sddm-flower-theme
Expand All @@ -153,14 +127,51 @@ chmod +x install-on-arch.sh
Current=sddm-flower-theme" | sudo tee /etc/sddm.conf
```

## Cheat sheet

## Detailed information

### Dependencies

<details>
<summary>Keybinds</summary>
**Base:** acpi alsa-utils base-devel curl git pulseaudio pulseaudio-alsa xorg xorg-xinit

**Required:** alacritty btop code dunst feh ffcast firefox i3-gaps i3lock-color i3-resurrect libnotify light mpc mpd ncmpcpp nemo neofetch neovim oh-my-zsh-git pacman-contrib papirus-icon-theme picom polybar ranger rofi scrot slop xclip zathura zathura-pdf-mupdf zsh

**Sddm:** qt5-graphicaleffects qt5-quickcontrols2 qt5-svg sddm

**Emoji:** fonts: noto-fonts noto-fonts-cjk noto-fonts-emoji noto-fonts-extra

### Used programs

- **Music Player:** [mpd](https://github.com/MusicPlayerDaemon/MPD) & [ncmpcpp](https://github.com/ncmpcpp/ncmpcpp)
- **Editor:** [neovim](https://github.com/neovim/neovim) / [vscode](https://github.com/microsoft/vscode)
- **Lockscreen:** [i3lock-color](https://github.com/Raymo111/i3lock-color)
- **Display Manager:** [sddm](https://github.com/sddm/sddm)
- **File manager:** [ranger](https://github.com/ranger/ranger) / [nemo](https://github.com/linuxmint/nemo)
- **Pdf reader:** [zathura](https://github.com/pwmt/zathura)
- **Monitor of Resources:** [btop](https://github.com/aristocratos/btop)

### Used themes

- **Shell Framework:** [Oh-My-Zsh](https://github.com/ohmyzsh/ohmyzsh)
- **Vscode Theme:** [One dark pro](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme)
- **Neovim Theme:** [AstroNvim](https://github.com/kabinspace/AstroVim)
- **Icons:** [Papirus dark](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
- **GTK Theme:** [Tokyo night](https://github.com/Fausto-Korpsvart/Tokyo-Night-GTK-Theme)
- **Display Manager Theme:** [Sddm-flower-theme](https://github.com/Keyitdev/sddm-flower-theme)

### Fonts

- **Icons:** [Feather](https://github.com/AT-UI/feather-font/blob/master/src/fonts/feather.ttf)
- **Interface Font:** [Open sans](https://fonts.google.com/specimen/Open+Sans#standard-styles)
- **Monospace Font:** [Roboto mono](https://fonts.google.com/specimen/Roboto+Mono#standard-styles)
- **Polybar Font:** [Iosevka nerd font](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/Iosevka)

### Keybinds

These are the basic keybinds. Read through the [i3](./config/i3/config) config for more keybinds.

Note: `Win` refers to the `Super/Mod` key.

| Keybind | Function |
| ---------------------- | ---------------------------------------- |
| `Win + Enter` | Launch terminal (alacritty) |
Expand Down Expand Up @@ -190,32 +201,42 @@ These are the basic keybinds. Read through the [i3](./config/i3/config) config f
| `Win + Shift + E` | Exit i3 |
| `Win + Shift + R` | Restart i3 |

Note: `Win` refers to the `Super/Mod` key.

</details>

<details>
<summary>Colors</summary>

| Color | Hex code |
| ---------------------- | ---------------------------------------- |
| background | #1b1b25 |
| background 2 | #282A36 |
| background 3 | #16161e |
| border | #343746 |
| foreground | #dedede |
| white | #eeffff |
| black | #15121c |
| red | #cb5760 |
| green | #999f63 |
| yellow | #d4a067 |
| blue | #6c90a8 |
| purple | #776690 |
| cyan | #528a9b |
| pink | #ffa8c5 |
| orange | #c87c3e |

</details>
### Colors

| Color | Hex code |PNG | Color | Hex code |PNG|
| ---------------------- | -------- |- | ---------------------- | -------- |-|
| background | #1b1b25 |![#1b1b25](https://placehold.co/15x15/1b1b25/1b1b25.png) | red | #cb5760 |![#cb5760](https://placehold.co/15x15/cb5760/cb5760.png)|
| background 2 | #282A36 |![#282A36](https://placehold.co/15x15/282A36/282A36.png) | green | #999f63 |![#999f63](https://placehold.co/15x15/999f63/999f63.png)|
| background 3 | #16161e |![#16161e](https://placehold.co/15x15/16161e/16161e.png) | yellow | #d4a067 |![#d4a067](https://placehold.co/15x15/d4a067/d4a067.png)|
| border | #343746 |![#343746](https://placehold.co/15x15/343746/343746.png) | blue | #6c90a8 |![#6c90a8](https://placehold.co/15x15/6c90a8/6c90a8.png)|
| foreground | #dedede |![#dedede](https://placehold.co/15x15/dedede/dedede.png) | purple | #776690 |![#776690](https://placehold.co/15x15/776690/776690.png)|
| white | #eeffff |![#eeffff](https://placehold.co/15x15/eeffff/eeffff.png) | cyan | #528a9b |![#528a9b](https://placehold.co/15x15/528a9b/528a9b.png)|
| gray | #727480 |![#727480](https://placehold.co/15x15/727480/727480.png) | pink | #ffa8c5 |![#ffa8c5](https://placehold.co/15x15/ffa8c5/ffa8c5.png)|
| black | #15121c |![#15121c](https://placehold.co/15x15/15121c/15121c.png) | orange | #c87c3e |![#c87c3e](https://placehold.co/15x15/c87c3e/c87c3e.png)|

## Troubleshooting

1. Some polybar modules are not working?

- Try changing the variables.
- Open the polybar configuration `"$HOME"/.config/polybar/config.ini`.
- Found `; Change it for yourself` line.
- Follow the commands that are written below the `; Change it for yourself` line.

2. MPD not working?

- Check if any other program is using port 6600 (http://127.0.0.1:6600/).

3. Everything is lagging? Screen is tearing?

- Edit picom config.
- This can be hard to solve, because if picom does not work, the whole screen may be frozen or even dark. So first try to kill the picom process.
- (Blindly) click `Win+Enter`.
- (Blindly) type `killall picom`.
- (Blindly) press `Enter`.
- (Blindly) click `Win+Shift+R`.
- Open picom configuration `"$HOME"/.config/picom/picom.conf`.
- Change picom backend from `backend = "glx";` to `backend = "xrender";`.

## Support and Thankies

Expand Down
3 changes: 2 additions & 1 deletion install-on-arch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ copy_other_configs(){
sudo cp -r ./tokyonight_gtk /usr/share/themes
echo -e "${green}[*] Copying wallpapers to "$HOME"/Pictures/wallpapers.${no_color}"
cp -r ./wallpapers/* "$HOME"/Pictures/wallpapers
echo -e "${green}[*] Installing vsc extensions.${no_color}"
code --install-extension zhuangtongfa.Material-theme
echo -e "${green}[*] Copying vsc configs.${no_color}"
cp -r ./vsc/* "$HOME"/.vscode-oss/extensions
cp ./vsc/settings.json "$HOME"/.config/Code\ -\ OSS/User
echo -e "${green}[*] Copying zsh configs.${no_color}"
sudo cp ./keyitdev.zsh-theme /usr/share/oh-my-zsh/custom/themes
Expand Down
Binary file removed vsc/zhuangtongfa.material-theme-3.13.29.vsix
Binary file not shown.
46 changes: 0 additions & 46 deletions vsc/zhuangtongfa.material-theme-3.15.2/.vsixmanifest

This file was deleted.

Loading

0 comments on commit c48a005

Please sign in to comment.