awesomewm-machina/README.md

120 lines
4.1 KiB
Markdown
Raw Normal View History

2021-06-28 04:01:37 +02:00
### Why?
2021-06-27 08:57:56 +02:00
Layout-machi is great, however it requires you to use its built-in switcher to manage your open windows. If you are shuffling, swapping, and moving things around often, this could become counter productive.
2021-06-27 08:15:25 +02:00
`Machina` is built on top of layout-machi, and allows you to bind frequently used actions to your keys and gives you additional user friendly features.
2021-06-27 08:57:56 +02:00
A combination of `layout-machi` and `awesomewm-machina` will give you a similar experience to fancy zones on windows.
2021-06-27 08:15:25 +02:00
2021-06-28 04:01:37 +02:00
### What?
2021-06-27 08:15:25 +02:00
These are the features I added:
2021-06-27 09:11:08 +02:00
- Quick Expand:
2021-06-28 04:01:37 +02:00
Expand focused window to left, right, or vertically. This will make the window snap to the next available region.
2021-06-27 08:15:25 +02:00
2021-06-27 09:11:08 +02:00
- Directional Swapping:
2021-06-28 04:01:37 +02:00
Swap windows between regions.
2021-06-27 08:15:25 +02:00
2021-06-27 09:11:08 +02:00
- Directional Shifting:
2021-06-28 04:01:37 +02:00
Relocate windows like Elv13's collision module.
2021-06-27 08:15:25 +02:00
2021-06-27 09:11:08 +02:00
- Rotational Shifting:
2021-06-28 04:01:37 +02:00
Relocate windows clockwise or counter clockwise. This uses a different algorithm compared to directional shifting and should be more accurate in merging your floating clients to the tiling layout.
2021-06-27 08:15:25 +02:00
2021-06-27 09:11:08 +02:00
- Shuffling:
2021-06-28 04:01:37 +02:00
Go backward or forward in a region, and it will cycle the clients inside that area. Kind of like fake tabs.
2021-06-27 09:01:59 +02:00
2021-06-27 09:11:08 +02:00
- Auto-Hide Floating Windows:
2021-06-27 08:15:25 +02:00
Often times, the floating windows pollutes your background if you are using `useless-gaps`. Machina will hide those for you, but they can still be accessed through your window-switcher such as Rofi.
2021-06-27 09:11:08 +02:00
- Floating and Tiled:
2021-06-27 09:04:42 +02:00
All keybindings, including swapping work seamlessy on both the tiled and the floating windows. So, if you need to push that terminal to a corner, you can easily do so without changing it to tiling mode.
2021-06-27 08:15:25 +02:00
2021-06-28 04:01:37 +02:00
### Next?
2021-06-27 09:01:59 +02:00
2021-06-28 04:01:37 +02:00
The region shuffling works like tabs, but it would be nice to have a visual queue like tabs. That will be in the next version. I'm also planning to add chained keybindings kind of like in emacs and vi that displays a modal help window.
2021-06-10 16:28:28 +02:00
2021-06-28 04:01:37 +02:00
New layout-machi has some logic to auto expand your windows onto multiple regions. For some work flows this might be desired, but I might look into a way to disable that as I find it to get in the way when changing windows from float to tile. This is especially annoying when you have a centered float.
2021-06-27 09:01:59 +02:00
2021-06-28 04:01:37 +02:00
### Layout-Machi compatibility
2021-06-27 09:01:59 +02:00
2021-06-28 04:01:37 +02:00
Machina should work just fine with both versions of layout-machi.
2021-06-27 09:01:59 +02:00
2021-06-28 04:01:37 +02:00
### Problems?
2021-06-27 09:01:59 +02:00
2021-06-28 04:01:37 +02:00
If you have any issues or recommendations, please feel free to open a request. PRs are most welcome.
### Install
2021-06-10 16:28:28 +02:00
switch to your awesome config folder, typically at:
```
cd ~/.config/awesome
```
clone this repository:
```
2021-06-27 08:15:25 +02:00
git clone https://github.com/basaran/awesomewm-machina
2021-06-10 16:28:28 +02:00
```
and call it from your `rc.lua`
```lua
2021-06-27 08:15:25 +02:00
local machina = require('awesomewm-machina')()
2021-06-10 16:28:28 +02:00
```
2021-06-28 04:01:37 +02:00
### Keybindings
2021-06-27 08:15:25 +02:00
some of the default shortcuts are:
2021-06-10 16:28:28 +02:00
```lua
2021-06-28 11:21:43 +02:00
modkey + [ : shift to region (counter clock wise, infinite)
modkey + ] : shift to region (clock wise, infinite)
2021-06-10 16:55:06 +02:00
2021-06-28 11:44:57 +02:00
modkey + shift + [ : swap with client on left
modkey + shift + ] : swap with client on right
--|will keep the focus on the region you execute the
--|function, execute again to undo. if there is nothing on
--|the direction, it will look up or down.
2021-06-28 03:26:03 +02:00
modkey + shift + ' : prev within region
modkey + shift + ; : next within region
2021-06-27 08:15:25 +02:00
modkey + insert : quick expand to left side (toggle)
modkey + pageup : quick expand to right side (toggle)
2021-06-28 03:26:03 +02:00
modkey + delete : expand client vertically
2021-06-28 11:25:53 +02:00
modkey + home : center (float or tiled)
--|you can use this one like zooming, when executed on tiled
--|clients, it will toggle back to original region.
2021-06-28 11:21:43 +02:00
modkey + end : toggle float status
2021-06-27 08:15:25 +02:00
2021-06-27 08:57:56 +02:00
modkey + j : focus left
modkey + k : focus down
modkey + l : focus right
modkey + i : focus up
2021-06-28 11:21:43 +02:00
modkey + shift + j : shift to left region
modkey + shift + k : shift to down region
modkey + shift + l : shift to right region
modkey + shift + i : shift to up region
modkey + shift + insert : move to top-left
modkey + shift + page_up : move to top-right
modkey + shift + home : move to center
modkey + shift + end : move to center
modkey + shift + delete : move to bottom-left
modkey + shift + page_down : move to bottom-right
2021-06-28 11:25:53 +02:00
--|these will also work with tiled clients
2021-06-10 18:42:39 +02:00
```
2021-06-28 04:01:37 +02:00
2021-06-10 18:42:39 +02:00
### Preview
2021-06-27 10:46:59 +02:00
https://user-images.githubusercontent.com/30809170/123538385-ab5f7b80-d702-11eb-9a14-e8b9045d9d27.mp4
2021-06-10 18:42:39 +02:00