Keyitdev/dotfiles
1
0
Fork 0
mirror of https://github.com/Keyitdev/dotfiles.git synced 2026-09-24 01:52:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c44717f0f519663d5a5cfd8a4dc106817c91d873
dotfiles/README.md
T
LewisandKeyitdev c44717f0f5 Update: Update readme.
2022-06-22 19:29:41 +02:00

254 lines
12 KiB
Markdown
Executable File
Raw Blame History

<h1 align=center>Keyitdev Dotfiles</h1>
<p align="center">My personal build of dotfiles using i3. Color palette is based on OneDark color scheme. This configuration works also on dual monitors.</p>
<div align="center">
<a href="Showcase">Showcase</a> · <a href="#Info">Info</a> · <a href="#linux">Linux</a> · <a href="#scripts">Scripts</a>
</div>
[Showcase](https://github.com/keyitdev/dotfiles#Showcase) ·
[Info](https://github.com/keyitdev/dotfiles#Info) ·
[Dependencies](https://github.com/keyitdev/dotfiles#Dependencies) ·
[Installation](https://github.com/keyitdev/dotfiles#Installation) ·
[Keybinds](https://github.com/keyitdev/dotfiles#Keybinds) ·
[Colors](https://github.com/keyitdev/dotfiles#Colors) ·
[Troubleshooting](https://github.com/keyitdev/dotfiles#Troubleshooting)
<p align=center>
<img src="https://img.shields.io/github/stars/keyitdev/dotfiles?color=dd864a&labelColor=202328&style=for-the-badge">
<img src="https://img.shields.io/github/forks/keyitdev/dotfiles?color=82aaff&labelColor=202328&style=for-the-badge">
<img src="https://img.shields.io/github/issues/keyitdev/dotfiles?color=bf616a&labelColor=202328&style=for-the-badge">
<img src="https://img.shields.io/github/issues-pr/keyitdev/dotfiles?color=c792ea&labelColor=202328&style=for-the-badge">
<img src="https://img.shields.io/github/license/keyitdev/dotfiles?color=15121C&labelColor=202328&style=for-the-badge">
</p>
## 🌟 Showcase
![](https://github.com/Keyitdev/dotfiles/blob/screenshots/screenshots/main.png?raw=true)
### More screenshots [here](https://github.com/Keyitdev/dotfiles/blob/screenshots/README.md)
### Watch the demo video [here](https://www.youtube.com/watch?v=_dMkmf2ugPE)
## 🗒️ Info
|Program|Name|
|-|-|
|**Window Manager**|[i3-gaps](https://github.com/Airblader/i3)|
|**Terminal emullator**|[kitty](https://github.com/kovidgoyal/kitty)|
|**Bar**|[polybar](https://github.com/polybar/polybar)|
|**Application launcher**|[rofi](https://github.com/davatorium/rofi)|
|**Notifications**|[dunst](https://github.com/dunst-project/dunst)|
|**Login manger**|[sddm](https://github.com/sddm/sddm)|
|**Login manger theme**|[sddm-astronaut-theme](https://github.com/Keyitdev/sddm-astronaut-theme)|
|**Lock screen**|[betterlockscreen](https://github.com/betterlockscreen/betterlockscreen)|
|**Compositor**|[picom](https://github.com/yshui/picom)
|**Shell**|[zsh](https://www.zsh.org/)|
|**Shell theme**|[oh my zsh](https://github.com/ohmyzsh/ohmyzsh)|
|**Music**|[mpd](https://github.com/MusicPlayerDaemon/MPD), [ncmpcpp](https://github.com/ncmpcpp/ncmpcpp)
|**Text editor**|[Visual Studio Code](https://github.com/Microsoft/vscode), [neovim](https://github.com/neovim/neovim)|
|**Vsc theme**|[One Dark Pro](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme)|
|**Neovim theme**|[AstroVim](https://github.com/kabinspace/AstroVim)
|**GTK theme**|[Dracula (ant)](https://github.com/EliverLara/ant)|
|**GTK icons**|[Papirus](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)|
|**Discord Theme**|[My custom theme](https://github.com/Keyitdev/BetterDiscord-themes)|
## ⚡ Dependencies
### Packaged used
* base: base-devel wget curl git gcc make acpi light pulseaudio pulseaudio-alsa alsa-utils pacman-contrib mpc
* wm and X11: i3-gaps i3blocks i3lock-color xorg xorg-xinit xorg-server
* lockscreen: i3lock-color betterlockscreen feh imagemagick
* programs: kitty rofi dunst (with libnotify) ranger ncmpcpp mpd polybar papirus-icon-theme btop sddm zsh (with oh-my-zsh) picom cava code neovim
* screenshot script: xclip scrot ffcast slop
* emoji fonts: noto-fonts noto-fonts-emoji noto-fonts-extra noto-fonts-cjk
### Fonts used
* Icons: [Feather](https://github.com/AT-UI/feather-font/blob/master/src/fonts/feather.ttf)
* Main font: [Open sans](https://fonts.google.com/specimen/Open+Sans#standard-styles)
* Main monospace font: [Roboto mono](https://fonts.google.com/specimen/Roboto+Mono#standard-styles)
* Polybar: [Iosevka-Nerd-Font](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/Iosevka)
## 🛠️ Installation
I recommend manually installing packages and coping files, but if you are lazy or are a productive person who don't want to waste your time, you can try to use arch install script.
### Arch manually
1. Clone this dotfiles
```sh
git clone -b master --depth 1 https://www.github.com/keyitdev/dotfiles.git
```
1. Install AUR helper (for example yay in ~/.srcs)
```sh
mkdir -p ~/.srcs
git clone https://aur.archlinux.org/yay.git ~/.srcs/yay
(cd ~/.srcs/yay/ && makepkg -si )
```
1. Install packages (see [Dependecies](https://github.com/keyitdev/dotfiles#Dependecies))
1. Make light executable
```sh
sudo chmod +s /usr/bin/light
```
1. Copy files (config folder to `$HOME/.config`, scripts folder to `/usr/local/bin` fonts to `/usr/share/fonts/`, wallpaper to `$HOME/Pictures/wallpapers` etc.)
1. Install oh my zsh
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
1. Set zsh as default shell
```sh
chsh -s /bin/zsh
sudo chsh -s /bin/zsh
```
1. Install AstroVim
```sh
git clone --depth 10 https://github.com/kabinspace/AstroVim.git ~/.config/nvim
nvim +PackerSync
```
1. Install gtk3 theme
```sh
git clone https://github.com/EliverLara/ant.git
sudo mv ./ant /usr/share/themes
```
1. Install sddm astronaut theme
```sh
sudo git clone https://github.com/keyitdev/sddm-astronaut-theme.git
sudo cp -fdr sddm-astronaut-theme /usr/share/sddm/themes/
sudo cp /usr/share/sddm/themes/sddm-astronaut-theme/Fonts/* /usr/share/fonts/
```
1. Edit `/etc/sddm.conf`
```
[Theme]
Current=sddm-astronaut-theme
```
1. [Install Firefox theme](https://color.firefox.com/?theme=XQAAAAKGAQAAAAAAAABBqYhm849SCia73laEGccwS-xMDPr5iE6kjVUHIsGRvs0-q94VqJzDmLds0B4GdTFd2KORmhozpED9fKKY97YpmeSVCJcSVB9rwzacQGHhaYG0HJIDBXLbAYUnjpkVXo5LFBoIgdJ4P7MSUoS9tEpFY9l-n8P03V91Kq7BmmKKrjKq9Hi2Jvfl7wBEWz3nWVxnwd4XKskPQ2G_JFlEZFH-xMtfBJ5OSQmfzox2bvycbCOGiDW99yOqfX2u-cPiqZwcshaSPxDSqShJ5_7OhZzPbP5x-BM)
### Arch with script
1. Clone dotfiles
```
git clone -b master --depth 1 https://www.github.com/keyitdev/dotfiles.git
cd dotfiles
chmod +x install-on-arch.sh
./install-on-arch.sh
```
1. Install oh my zsh
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
1. Set zsh as default shell
```sh
chsh -s /bin/zsh
sudo chsh -s /bin/zsh
```
1. Install AstroVim
```sh
git clone --depth 10 https://github.com/kabinspace/AstroVim.git ~/.config/nvim
nvim +PackerSync
```
1. Install gtk3 theme
```sh
git clone https://github.com/EliverLara/ant.git
sudo mv ./ant /usr/share/themes
```
1. Install sddm astronaut theme
```sh
sudo git clone https://github.com/keyitdev/sddm-astronaut-theme.git
sudo cp -fdr sddm-astronaut-theme /usr/share/sddm/themes/
sudo cp /usr/share/sddm/themes/sddm-astronaut-theme/Fonts/* /usr/share/fonts/
```
1. Edit `/etc/sddm.conf`
```
[Theme]
Current=sddm-astronaut-theme
```
1. [Install Firefox theme](https://color.firefox.com/?theme=XQAAAAKGAQAAAAAAAABBqYhm849SCia73laEGccwS-xMDPr5iE6kjVUHIsGRvs0-q94VqJzDmLds0B4GdTFd2KORmhozpED9fKKY97YpmeSVCJcSVB9rwzacQGHhaYG0HJIDBXLbAYUnjpkVXo5LFBoIgdJ4P7MSUoS9tEpFY9l-n8P03V91Kq7BmmKKrjKq9Hi2Jvfl7wBEWz3nWVxnwd4XKskPQ2G_JFlEZFH-xMtfBJ5OSQmfzox2bvycbCOGiDW99yOqfX2u-cPiqZwcshaSPxDSqShJ5_7OhZzPbP5x-BM)
## 🛠️ Uninstallation
1. Remove installed packages (see [Dependecies](https://github.com/keyitdev/dotfiles#Dependecies))
2. Remove AUR helper ( ~/.srcs)
3. Unistall oh my zsh ` uninstall_oh_my_zsh`
4. Change shell back to bash
```
chsh -s /bin/bash
sudo chsh -s /bin/bash
```
5. Remove installed fonts (~/.local/share/fonts/ or /usr/share/fonts/)
6. Remove installed scripts (/usr/local/bin)
7. Delete this repo
## 🔑 Keybinds
These are the basic keybinds. Read through the `i3` config for more keybinds.
| Keybind | Function |
| ---------------------- | ---------------------------------------- |
| `Win + Enter` | Launch terminal (kitty) |
| `Win + Shift + Q` | Close window |
| `Win + Q` | Stacking layout |
| `Win + W` | Tabbed layout |
| `Win + E` | Default layout |
| `Win + A` | Rofi sidebar menu |
| `Win + S` | Rofi compact menu |
| `Win + D` | Rofi center menu |
| `Win + Z` | Rofi bookmarks |
| `Win + X` | Change theme |
| `Win + C` | Use screenshot script |
| `Win + G` | Gaps settings |
| `Win + V` | Set vertical orientation |
| `Win + H` | Set horizontal orientation |
| `Win + I` | Lock screen |
| `Win + O` | Show polybar |
| `Win + P` | Hide polybar |
| `Win + B` | Move workspace to another monitor |
| `Win + N` | Dual monitor mode |
| `Win + M` | Single monitor mode |
| `Win + arrows (jkl;)` | Resizing, moving windows |
| `Win + Shift + E` | Exit i3 |
| `Win + Shift + R` | Restart i3 |
Note: `Win` refers to the `Super/Mod` key.
## 🌈 Colors
| Color | Hex code |
| ---------------------- | ---------------------------------------- |
| background | #21222C |
| background 2 | #282A36 |
| background 3 | #343746 |
| foreground | #F8F8F2 |
| white | #FFFFFF |
| black | #15121C |
| red | #f07178 |
| green | #c3e88d |
| yellow | #ffcb6b |
| blue | #82aaff |
| purple | #c792ea |
| cyan | #89ddff |
| pink | #ffa8c5 |
| orange | #dd864a |
## ⚙️ Troubleshooting
1. Polybar modules not working : Try changing variables (For example in battery module from BAT1 to BAT0).
2. Black flashing screen : Try changing picom config.
3. Scripts not working : Maybe try to edit bang.
4. Mpd not working : Check if any other program isn't using port 6600 (http://127.0.0.1:6600/).
## ✨ Big thanks to
These dotfiles includes some files from others rices. Original sources:
* [Totoro](https://github.com/totoro-ghost) for [polybar frontend](https://github.com/totoro-ghost/dotfiles/tree/master/.config/polybar)
* [Adi1090x](https://github.com/adi1090x) for [rofi backend](https://github.com/adi1090x/rofi)
* [Alexander-Miller](https://github.com/Alexander-Miller) for [ncmpcpp config](https://github.com/Alexander-Miller/dotfiles/blob/master/.config/ncmpcpp/config)
* [Axarva](https://github.com/Axarva/) for [arch install script](https://github.com/Axarva/dotfiles-2.0/blob/main/install-on-arch.sh)
* [Ceuk](https://github.com/ceuk/) for [rofi screenshot script](https://github.com/ceuk/rofi-screenshot)
* [Milosz](https://github.com/milosz) for [rofi-bookmarks](https://github.com/milosz/rofi-firefox-bookmarks)
* [Unnat](https://github.com/UnnatShaneshwar) for [wallpaper](https://github.com/UnnatShaneshwar/OneDarkWallpapers/blob/main/11.png)
## 🪪 License
Distributed under the [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.html) License.
Reference in New Issue View Git Blame Copy Permalink