Skip to content

Commit b119ce2

Browse files
adrianvicadrianvic
authored
Enhance README with dependencies and shortcuts
Updated README to include additional dependencies and modified keyboard shortcuts for Sway configuration.
1 parent 2b058df commit b119ce2

File tree

1 file changed

+75
-28
lines changed

1 file changed

+75
-28
lines changed

‎README.md‎

Lines changed: 75 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,45 @@
22
This is the repository for my dotfiles for Sway, forked from [Flipe Facundes](https://github.com/felipefacundes/dotfiles).
33

44
## Dependencies
5+
6+
> [!IMPORTANT]
7+
> This dotfile has configuration specific to SwayFX, if you're using Sway, please comment out the configuration section used by SwayFX.
8+
59
The dotfiles configuration references a lot of packages that may not be installed on your system:
610

711
```
8-
swayfx swayidle swaybg waybar rofi wlrctl cliphist lights ly kwalletd6 rofi-power-menu grim wl-clipboard xorg-xprop libpulse dunst rofi-pulse-select soteria keepmenu
12+
swayfx swayidle swaybg waybar rofi wlrctl cliphist lights ly kwalletd6 rofi-power-menu grim wl-clipboard xorg-xprop libpulse dunst rofi-pulse-select soteria keepmenu python-pykeepass ydotool
913
```
1014

15+
<details>
16+
<summary>Dependency table</summary>
17+
18+
| Name | Reason |
19+
|-------------------|-------------------------------------------------------------------------------------------------------------------|
20+
| swayfx | Window manager ¯\_(ツ)_/¯ |
21+
| swayidle | Puts your computer to sleep after certain amount of time. |
22+
| swaybg | Wallpaper util |
23+
| waybar | Status bar |
24+
| rofi | Application/power menu, also used for switching audio in/outputs and accessing KeePass DBs. |
25+
| wlrctl | Moving the cursor with keyboard keybinds. |
26+
| cliphist | Waybar's "[Clipboard]" button uses to show clipboard history. |
27+
| lights | Backlight control |
28+
| ly | Login screen |
29+
| kwalletd6 | Keyring |
30+
| rofi-power-menu | Power options provider for Rofi |
31+
| grim | Used to select screen sections for screenshots, only needed for selection screenshot. |
32+
| wl-clipboard | Provides control over Wayland clipboard. |
33+
| xorg-xprop | Used to set XWayland display scale. |
34+
| libpulse | |
35+
| dunst | Delivers notifications, some apps (Electron-based) will hang when you receive a notification if it's not present. |
36+
| rofi-pulse-select | Provides audio in/output for Rofi. |
37+
| soteria | Polkit, asks for elevation when needed. Akin to Windows' ACL. |
38+
| keepmenu | KeePass provider for Rofi |
39+
| python-pykeepass | Dependency of KeepMenu |
40+
| ydotool | KeepMenu uses this to type passwords. |
41+
42+
</details>
43+
1144
# SwayWM
1245
<img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/bf0b98b5-8246-4737-bcf2-cf37287cc7b1" />
1346

@@ -20,64 +53,78 @@ In `.config/sway/config` replace XX from the line `import strings_XX` to a langu
2053
Edit `.config/sway/startup` and add `exec yourapplication`.
2154

2255
## Keyboard Shortcuts
56+
<details>
57+
<summary>Default modifiers</summary>
58+
59+
- `Mod` is Super by default.
60+
- `Menu` is the context menu button, generally only present in full-size keyboards.
61+
62+
</details>
63+
2364
### Window management
24-
- `Super+Shift+[Arrow Keys]` Move windows
25-
- `Super+Shift+Q` Close window
65+
- `Mod+Shift+[Arrow Keys]` Move windows
66+
- `Mod+Shift+Q` Close window
2667
- `Ctrl+Alt+Esc` Kill window
27-
- `Super+Tab` Toggle floating window for selection
68+
- `Mod+Tab` Toggle floating window for selection
2869
- `Alt+Tab` Toggle focus between floating and tiling windows
29-
- `Super+Shift+C` Move window to center
30-
- `Super+F` Toggle fullscreen mode
31-
- `Super+S` Layout toggle split
32-
- `Super+W` Layout toggle tabbed
33-
- `Super+A` Layout toggle stacked
34-
- `Super+Shift+[Arrow Keys]` Move window to workspace
70+
- `Mod+Shift+C` Move window to center
71+
- `Mod+F` Toggle fullscreen mode
72+
- `Mod+S` Layout toggle split
73+
- `Mod+W` Layout toggle tabbed
74+
- `Mod+A` Layout toggle stacked
75+
- `Mod+Shift+[Arrow Keys]` Move window to workspace
3576
In .config/sway/config replace XX from the line import strings_XX to a language code matching a language file in that same directory.
77+
3678
#### Resize mode
37-
- `Super+R` Enter resize mode
79+
- `Mod+R` Enter resize mode
3880
- `Esc`/`Return` Exit resize mode
3981
- `[Arrow Keys]` Resize window
4082

4183
### Window Navigation
42-
- `Super+[Arrow Keys]` Navigate through windows
43-
- `Super+[Number Keys]` Navigate through workspaces
44-
- `Super+D` Go back and forth on workspaces
84+
- `Mod+[Arrow Keys]` Navigate through windows
85+
- `Mod+[Number Keys]` Navigate through workspaces
86+
- `Mod+D` Go back and forth on workspaces
4587

4688
### Cursor navigation
47-
- `Super+Equal`/`Super+Next` Right mouse button click
48-
- `Super+Minus`/`Super+KP_7` Left mouse button click
49-
- `Super+Ctrl+[Arrow Keys]` Move cursor
89+
- `Mod+Equal`/`Mod+Next` Right mouse button click
90+
- `Mod+Minus`/`Mod+KP_7` Left mouse button click
91+
- `Mod+Ctrl+[Arrow Keys]` Move cursor
5092

5193
### Media
5294
- `XF86AudioRaiseVolume` (volume up button) raises volume
5395
- `XF86AudioLowerVolume` (volume down button) lowers volume
5496
- `XF86AudioMute` (mute button) mutes the volume
55-
- `Super+P` Opens volume control (pavucontrol)
97+
- `Mod+P` Opens volume control (pavucontrol)
5698
- `XF86MonBrightnessUp` (brightness up button) raises brightness
5799
- `XF86MonBrightnessDown` (brightness down button) lowers brightness
58100
- `XF86ScreenSaver` (screen saver button) set brightness to 0
59101
- `Alt+Space` Pause media playback
60102

61103
### Applications
62-
- `Super+Space` Application launcher (Rofi)
63-
- `Super+Enter` Terminal (Alacritty)
64-
- `Ctrl+Esc` Task manager (HTOP)
65-
- `Ctrl+Super+F` Web browser (Floorp)
66-
- `Super+E` File explorer (xdg-open)
104+
- `Mod+Space` Application launcher (Rofi)
105+
- `Mod+Enter` Terminal (Kitty)
106+
- `Mod+Esc` Task manager (HTOP)
107+
- `Ctrl+Mod+F` Web browser (Floorp)
108+
- `Mod+E` File explorer (xdg-open)
67109
- `Print` Select screen area to save to clipboard
68110
- `Ctrl+Print` Saves a full screenshot to clipboard
69111
- `Ctrl+Shift+Print` Saves a full screenshot to `${HOME}/Pictures/Capture/${date + "%Y-%m-%d %H:%M:%S"} - Capture.png`)
70112
- `Ctrl+Alt+R` OBS Studio
71113

114+
#### KeePass
115+
- `Menu` Access loaded KeePass DB (if not loaded it will prompt for the DB directory, use the shortcut below to open the default DB)
116+
- `Mod+Menu` Load and open default DB (defined in the config)
117+
72118
### System
73119
- `Ctrl+L` Lock with swaylock
74120
- `Ctrl+Shift+L` Power options (Rofi)
75121
- `Ctrl+Shift+Alt+Delete` Power off
76-
- `Super+U` System update (`pacman -Syu`)
77-
- `Super+Ctrl+R` Reload Sway
78-
- `Super+Shift+E` Exit Sway
79-
- `Ctrl+Super+Q` Kill Sway
80-
- `Alt+Apostrophe` Change audio output
122+
- `Mod+U` System update (`pacman -Syu`)
123+
- `Mod+Ctrl+R` Reload Sway
124+
- `Mod+Shift+E` Exit Sway
125+
- `Ctrl+Mod+Q` Kill Sway
126+
- `Alt+Apostrophe` Change audio output (sink)
127+
- `Alt+Shift+Apostrophe` Change audio input (source)
81128

82129
# ly display manager
83130
<img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/5e8a8ab3-e872-4a85-b248-202ba8d9a36b" />

0 commit comments

Comments
 (0)