Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leukipp/cortile
Linux auto tiling manager with hot corner support for Openbox, Fluxbox, IceWM, Xfwm, KWin, Marco, Muffin, Mutter and other EWMH compliant window managers using the X11 window system. Therefore, this project provides dynamic tiling for XFCE, LXDE, LXQt, KDE and GNOME (Mate, Deepin, Cinnamon, Budgie) based desktop environments.
https://github.com/leukipp/cortile
dynamic-window-manager ewmh fluxbox gnome golang hot-corners icewm kde kwin linux lxde lxqt marco muffin mutter openbox tiling-window-manager window-manager x11 xfce
Last synced: about 2 months ago
JSON representation
Linux auto tiling manager with hot corner support for Openbox, Fluxbox, IceWM, Xfwm, KWin, Marco, Muffin, Mutter and other EWMH compliant window managers using the X11 window system. Therefore, this project provides dynamic tiling for XFCE, LXDE, LXQt, KDE and GNOME (Mate, Deepin, Cinnamon, Budgie) based desktop environments.
- Host: GitHub
- URL: https://github.com/leukipp/cortile
- Owner: leukipp
- License: mit
- Created: 2021-11-29T20:28:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T08:41:48.000Z (about 2 months ago)
- Last Synced: 2024-08-01T09:25:59.921Z (about 2 months ago)
- Topics: dynamic-window-manager, ewmh, fluxbox, gnome, golang, hot-corners, icewm, kde, kwin, linux, lxde, lxqt, marco, muffin, mutter, openbox, tiling-window-manager, window-manager, x11, xfce
- Language: Go
- Homepage:
- Size: 7.6 MB
- Stars: 540
- Watchers: 9
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cortile
Linux auto tiling manager with hot corner support for Openbox, Fluxbox, IceWM, Xfwm, KWin, Marco, Muffin, Mutter and other [EWMH](https://en.wikipedia.org/wiki/Extended_Window_Manager_Hints#List_of_window_managers_that_support_Extended_Window_Manager_Hints) compliant window managers using the [X11](https://en.wikipedia.org/wiki/X_Window_System) window system.
Therefore, this project provides dynamic tiling for XFCE, LXDE, LXQt, KDE and GNOME (Mate, Deepin, Cinnamon, Budgie) based desktop environments.
Simply keep your current window manager and install **cortile on top** of it.
Once enabled, the tiling manager will handle _resizing_ and _positioning_ of _existing_ and _new_ windows.
## Features [](#features-)
- [x] Workspace based tiling.
- [x] Auto detection of panels.
- [x] User interface for tiling mode.
- [x] Systray icon indicator and menu.
- [x] Keyboard, hot corner and systray bindings.
- [x] Vertical, horizontal and fullscreen mode.
- [x] Socket communication commands.
- [x] Remember layout proportions.
- [x] Floating and sticky windows.
- [x] Drag & drop window swap.
- [x] Workplace aware layouts.
- [x] Multi monitor support.
Support for **keyboard and mouse** events sets cortile apart from other tiling solutions.
The _go_ implementation ensures a fast and responsive system, where _multiple layouts_, _keyboard shortcuts_, _drag & drop_ and _hot corner_ events simplify and speed up your daily work.
[](https://github.com/leukipp/cortile/blob/main/assets/images/demo.gif)
## Installation [](#installation-)
Manually `download`/`extract` the latest binary file from [releases](https://github.com/leukipp/cortile/releases/latest) or use `wget`/`tar`:
```bash
wget -qO- $(wget -qO- https://api.github.com/repos/leukipp/cortile/releases/latest | \
jq -r '.assets[] | select(.name | contains ("linux_amd64.tar.gz")) | .browser_download_url') | \
tar -xvz
```
Run the binary file and cortile will automatically tile until you stop it:
```bash
./cortile
```
Another installation method can be found in the [development](#development-) section.
The latest official release is published on GitHub.
Versions distributed via package managers are community supported and may be outdated.
### Service
To enable auto tiling on startup, you can run cortile as a service after the graphical user interface has been loaded.
A template to run cortile as a [systemd](https://en.wikipedia.org/wiki/Systemd) service is provided in the [services](https://github.com/leukipp/cortile/tree/main/assets/services) folder.
You may have to adjust the filepath/symlink under `ExecStart` and enable the user service:
```bash
# copy systemd service file
cp cortile.service ~/.config/systemd/user/
# reload systemd configuration
systemctl --user daemon-reload
# enable systemd service
systemctl --user enable cortile.service
# start systemd service
systemctl --user start cortile.service
```
### Usage
The layouts are based on the master-slave concept, where one side of the screen is considered to be the master area and the other side is considered to be the slave area:
- `vertical-right:` split the screen vertically, master area on the right.
- `vertical-left:` split the screen vertically, master area on the left.
- `horizontal-top:` split the screen horizontally, master area on the top.
- `horizontal-bottom:` split the screen horizontally, master area on the bottom.
- `maximized:` single window that fills the entire tiling area.
- `fullscreen:` single window that fills the entire screen.
The number of windows per side and the occupied space can be changed dynamically.
Adjustments to window sizes are considered to be proportion changes of the underlying layout.
Windows placed on the master side are static and the layout will only change as long the space is not fully occupied.
Once the master area is full, the slave area is used, where the layout changes dynamically based on available space and configuration settings.
## Configuration [](#configuration-)
The configuration file is located at `~/.config/cortile/config.toml` (or `XDG_CONFIG_HOME`) and is created with default values during the first startup.
Additional information about individual entries can be found in the comments section of the [config.toml](https://github.com/leukipp/cortile/blob/main/config.toml) file.
[](https://github.com/leukipp/cortile/blob/main/assets/images/config.gif)
### Shortcuts
The default keyboard shortcuts are assigned as shown below.
If some of them are already in use by your system, update the default values in the `[keys]` section of the configuration file:
| Keys | Description |
| ------------------------------------------------------- | ---------------------------------------- |
| Ctrl+Shift+Home | Enable tiling on the current screen |
| Ctrl+Shift+End | Disable tiling on the current screen |
| Ctrl+Shift+R | Disable tiling and restore windows |
| Ctrl+Shift+T | Toggle between enable and disable |
| Ctrl+Shift+BackSpace | Reset layouts to default proportions |
| Ctrl+Shift+Next | Cycle through next layouts |
| Ctrl+Shift+Prior | Cycle through previous layouts |
| Ctrl+Shift+Left | Activate vertical-left layout |
| Ctrl+Shift+Right | Activate vertical-right layout |
| Ctrl+Shift+Up | Activate horizontal-top layout |
| Ctrl+Shift+Down | Activate horizontal-bottom layout |
| Ctrl+Shift+Space | Activate maximized layout |
| Ctrl+Shift+Return | Activate fullscreen layout |
| Ctrl+Shift+KP_5 | Make the active window master |
| Ctrl+Shift+KP_6 | Make the next window master |
| Ctrl+Shift+KP_4 | Make the previous window master |
| Ctrl+Shift+KP_Add | Increase number of master windows |
| Ctrl+Shift+KP_Subtract | Decrease number of master windows |
| Ctrl+Shift+Plus | Increase number of maximum slave windows |
| Ctrl+Shift+Minus | Decrease number of maximum slave windows |
| Ctrl+Shift+KP_3 | Increase proportion of master-slave area |
| Ctrl+Shift+KP_1 | Decrease proportion of master-slave area |
| Ctrl+Shift+KP_2 | Focus next window |
| Ctrl+Shift+KP_8 | Focus previous window |
Hot corner events are defined under the `[corners]` section and are triggered when the pointer enters one of the target areas:
| Corners | Description |
| ---------------------------------- | ---------------------------------------- |
| Top-Left | Focus previous window |
| Top-Right | Make the active window master |
| Bottom-Right | Increase proportion of master-slave area |
| Bottom-Left | Decrease proportion of master-slave area |
Systray events are defined under the `[systray]` section and are triggered when the pointer keys are pressed while hovering the icon:
| Pointer | Description |
| ---------------------------------- | ---------------------------------------- |
| Middle-Click | Toggle between enable and disable |
| Scroll-Up | Cycle through previous layouts |
| Scroll-Down | Cycle through next layouts |
| Scroll-Right | Increase proportion of master-slave area |
| Scroll-Left | Decrease proportion of master-slave area |
Common pointer shortcuts used in some environments:
- Move window: Alt+Left-Click.
- Resize window: Alt+Right-Click.
- Maximize window: Alt+Double-Click.
## Communication [](#communication-)
External processes may communicate directly with cortile using [unix domain sockets](https://en.wikipedia.org/wiki/Unix_domain_socket).
The sock parameter (`-sock /tmp/cortile.sock`) defines a path for a socket file that can be used to exchange data between processes.
Internally however, two socket files are used.
One is for incoming (`/tmp/cortile.sock.in`) and one for outgoing (`/tmp/cortile.sock.out`) communication.
Outgoing - Events
### Outgoing events and states
User triggered events (e.g. tile workspace) are broadcasted to the outgoing socket as json string.
One can listen to them by using [netcat](https://en.wikipedia.org/wiki/Netcat) or similar [alternatives](https://en.wikipedia.org/wiki/Netcat#Ports_and_reimplementations):
```bash
# Netcat
nc -Ulk /tmp/cortile.sock.out
# Socat
socat UNIX-LISTEN:/tmp/cortile.sock.out,reuseaddr,fork STDOUT
```
For debugging purposes, you can also dump the json messages into a file:
```bash
# Netcat
nc -Ulk /tmp/cortile.sock.out 2>&1 | tee /tmp/cortile.json
# Socat
socat -v UNIX-LISTEN:/tmp/cortile.sock.out,reuseaddr,fork OPEN:/tmp/cortile.json,create,truncate
```
Incoming - Commands
### Incoming commands and requests
Similarly, requests about the internal state of cortile can be sent to the incoming socket:
```bash
# Netcat
echo '{"State":"workspaces"}' | nc -U /tmp/cortile.sock.in
# Socat
echo '{"State":"workspaces"}' | socat STDIN UNIX-CONNECT:/tmp/cortile.sock.in
```
Since the communication is asynchronous, it is necessary to listen to the outgoing socket at the same time in order to receive the response.
Example files for sending commands and receiving states can be found in the [scripts](https://github.com/leukipp/cortile/tree/main/assets/scripts) folder.
## Development [](#development-)
You need [go >= 1.20](https://go.dev/dl/) to compile cortile.
Install - go
### Option 1: Install go via package manager
Use a package manager supported on your system:
```bash
# apt
sudo apt install golang
# yum
sudo yum install golang
# dnf
sudo dnf install golang
# pacman
sudo pacman -S go
```
### Option 2: Install go via archive download
Download a binary release suitable for your system:
```bash
cd /tmp/ && wget https://dl.google.com/go/go1.20.linux-amd64.tar.gz
sudo tar -xvf go1.20.linux-amd64.tar.gz
sudo mv -fi go /usr/local
```
Set required environment variables:
```bash
echo "export PATH=$PATH:/usr/local/go/bin" >> ~/.profile
echo "export GOPATH=~/.go" >> ~/.profile
source ~/.profile
```
Verify the installed go version:
```bash
go env | grep "GOPATH\|GOVERSION"
```
Install - cortile
### Option 1: Install cortile via remote source
Install directly from develop branch:
```bash
go install github.com/leukipp/cortile@develop
```
### Option 2: Install cortile via local source
Clone source code from develop branch:
```bash
git clone https://github.com/leukipp/cortile.git -b develop
cd cortile
```
If necessary you can make local changes, then execute:
```bash
go install -ldflags="-X 'main.date=$(date --iso-8601=seconds)'"
```
Start cortile in verbose mode:
```bash
$GOPATH/bin/cortile -v
```
## Additional [](#additional-)
Special settings:
- Use the `edge_margin` property to account for additional spaces.
- e.g. for deskbar panels or conky infographics.
- Use the `window_slaves_max` property to limit the number of windows.
- e.g. with one active master and `window_slaves_max = 2`, all windows following the third window are stacked behind the two slaves.
Hot corners:
- Use `tiling_enabled = false` if you prefer to utilize only the hot corner functionalities.
- Use the hot `[corners]` properties to execute any external command available on your system.
- e.g. use `bottom_center = "firefox"` to open a web browser window.
Systray:
- Use the `tiling_icon` property to add any external command to the systray menu.
- e.g. use `tiling_icon = [...,['firefox', 'Open Browser'],...]` to add a web browser entry.
## Issues [](#issues-)
Cortile works best with Xfwm and Openbox window systems.
However, it`s still possible that you may encounter problems during usage.
Windows:
- It's recommended to disable all build-in window snapping features (snap to other windows, snap to screen borders).
- Automatic panel detection may not work under some window managers, use the `edge_margin` property to adjust for additional margins.
- Particularly in GNOME based desktop environments, window displacements or resizing issues may occur.
- Sticky windows may cause unwanted layout modifications during workspace changes.
Systray:
- Adjust the bindings in the `[systray]` section, as some pointer events may not fire across different desktop environments.
- Window managers not supporting [StatusNotifierItem](https://freedesktop.org/wiki/Specifications/StatusNotifierItem) for displaying systray icons will need to install [snixembed](https://github.com/fyne-io/systray#linuxbsd).
Debugging:
- If you encounter problems start the process with `cortile -vv`, which provides additional debug outputs.
- A log file is created by default under `/tmp/cortile.log`.
## Credits [](#credits-)
Based on [zentile](https://github.com/blrsn/zentile) ([Berin Larson](https://github.com/blrsn)) and [pytyle3](https://github.com/BurntSushi/pytyle3) ([Andrew Gallant](https://github.com/BurntSushi)).
The main libraries used in this project are [xgbutil](https://github.com/BurntSushi/xgbutil), [toml](https://github.com/BurntSushi/toml), [systray](https://github.com/fyne-io/systray), [dbus](https://github.com/godbus/dbus), [fsnotify](https://github.com/fsnotify/fsnotify) and [logrus](https://github.com/sirupsen/logrus).
## License [](#license-)
[MIT](https://github.com/leukipp/cortile/blob/main/LICENSE)